Class DeviceEndpoint
java.lang.Object
org.keycloak.protocol.AuthorizationEndpointBase
org.keycloak.protocol.oidc.grants.device.endpoints.DeviceEndpoint
- All Implemented Interfaces:
Provider
,RealmResourceProvider
- Author:
- Hiroyuki Wada
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final org.jboss.logging.Logger
static final String
Fields inherited from class org.keycloak.protocol.AuthorizationEndpointBase
APP_INITIATED_FLOW, authManager, clientConnection, event, headers, httpRequest, realm, session
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
protected AuthenticationSessionModel
createAuthenticationSession
(ClientModel client, String scope) static OAuth2DeviceCodeModel
getDeviceByUserCode
(KeycloakSession session, RealmModel realm, String userCode) jakarta.ws.rs.core.Response
Handles device authorization requests.jakarta.ws.rs.core.Response
jakarta.ws.rs.core.Response
Showing the result of verification process for OAuth 2.0 Device Authorization Grant.jakarta.ws.rs.core.Response
Verifies the code provided by the end-user and start the authentication.jakarta.ws.rs.core.Response
verifyUserCode
(String userCode) This endpoint is used by end-users to start the flow to authorize a device.Methods inherited from class org.keycloak.protocol.AuthorizationEndpointBase
checkRealm, checkSsl, createProcessor, getAuthenticationFlow, handleBrowserAuthenticationRequest
-
Field Details
-
logger
protected static final org.jboss.logging.Logger logger -
SHORT_VERIFICATION_URI
- See Also:
-
-
Constructor Details
-
DeviceEndpoint
-
-
Method Details
-
handleDeviceRequest
@Path("") @POST @Consumes("application/x-www-form-urlencoded") @Produces("application/json") public jakarta.ws.rs.core.Response handleDeviceRequest()Handles device authorization requests.- Returns:
- the device authorization response.
-
preflight
@OPTIONS public jakarta.ws.rs.core.Response preflight() -
verifyUserCode
This endpoint is used by end-users to start the flow to authorize a device.- Parameters:
userCode
- the user code to authorize- Returns:
-
verifyUserCode
@Path("/") @POST @Consumes("application/x-www-form-urlencoded") public jakarta.ws.rs.core.Response verifyUserCode()Verifies the code provided by the end-user and start the authentication.- Returns:
-
status
Showing the result of verification process for OAuth 2.0 Device Authorization Grant. This outputs login success or failure messages.- Parameters:
error
-- Returns:
-
getDeviceByUserCode
public static OAuth2DeviceCodeModel getDeviceByUserCode(KeycloakSession session, RealmModel realm, String userCode) -
getResource
- Specified by:
getResource
in interfaceRealmResourceProvider
-
close
public void close() -
createAuthenticationSession
- Overrides:
createAuthenticationSession
in classAuthorizationEndpointBase
-