Package org.keycloak.protocol.oidc.grants.device

Class DeviceGrantType

java.lang.Object

org.keycloak.protocol.oidc.grants.device.DeviceGrantType

public class DeviceGrantType
extends Object

Author:

Hiroyuki Wada, Michito Okai

Field Summary

Fields

Modifier and Type	Field	Description
static String	OAUTH2_DEVICE_USER_CODE
static String	OAUTH2_DEVICE_VERIFIED_USER_CODE
static String	OAUTH2_USER_CODE_VERIFY

Constructor Summary

Constructors

Constructor	Description
DeviceGrantType(javax.ws.rs.core.MultivaluedMap<String,String> formParams, org.keycloak.models.ClientModel client, org.keycloak.models.KeycloakSession session, TokenEndpoint tokenEndpoint, org.keycloak.models.RealmModel realm, org.keycloak.events.EventBuilder event, Cors cors)

Method Summary

Modifier and Type	Method	Description
static javax.ws.rs.core.Response	approveOAuth2DeviceAuthorization(org.keycloak.sessions.AuthenticationSessionModel authSession, org.keycloak.models.AuthenticatedClientSessionModel clientSession, org.keycloak.models.KeycloakSession session)
static boolean	approveUserCode(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String userCode, String userSessionId, Map<String,String> additionalParams)
static javax.ws.rs.core.Response	denyOAuth2DeviceAuthorization(org.keycloak.sessions.AuthenticationSessionModel authSession, org.keycloak.protocol.LoginProtocol.Error error, org.keycloak.models.KeycloakSession session)
static boolean	denyUserCode(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String userCode)
static org.keycloak.models.OAuth2DeviceCodeModel	getDeviceByDeviceCode(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String deviceCode)
static boolean	isOAuth2DeviceVerificationFlow(org.keycloak.sessions.AuthenticationSessionModel authSession)
static boolean	isPollingAllowed(org.keycloak.models.KeycloakSession session, org.keycloak.models.OAuth2DeviceCodeModel deviceCodeModel)
static javax.ws.rs.core.UriBuilder	oauth2DeviceAuthUrl(javax.ws.rs.core.UriBuilder baseUriBuilder)
javax.ws.rs.core.Response	oauth2DeviceFlow()
static javax.ws.rs.core.UriBuilder	oauth2DeviceVerificationCompletedUrl(javax.ws.rs.core.UriInfo baseUri)
static javax.ws.rs.core.UriBuilder	oauth2DeviceVerificationUrl(javax.ws.rs.core.UriInfo uriInfo)
static URI	realmOAuth2DeviceVerificationAction(URI baseUri, String realmName)
static void	removeDeviceByDeviceCode(org.keycloak.models.KeycloakSession session, String deviceCode)
static void	removeDeviceByUserCode(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, String userCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OAUTH2_DEVICE_VERIFIED_USER_CODE

public static final String OAUTH2_DEVICE_VERIFIED_USER_CODE

See Also:

Constant Field Values

OAUTH2_DEVICE_USER_CODE

public static final String OAUTH2_DEVICE_USER_CODE

See Also:

Constant Field Values

OAUTH2_USER_CODE_VERIFY

public static final String OAUTH2_USER_CODE_VERIFY

See Also:

Constant Field Values

Constructor Detail

DeviceGrantType

public DeviceGrantType(javax.ws.rs.core.MultivaluedMap<String,String> formParams,
                       org.keycloak.models.ClientModel client,
                       org.keycloak.models.KeycloakSession session,
                       TokenEndpoint tokenEndpoint,
                       org.keycloak.models.RealmModel realm,
                       org.keycloak.events.EventBuilder event,
                       Cors cors)

Method Detail

oauth2DeviceVerificationUrl

public static javax.ws.rs.core.UriBuilder oauth2DeviceVerificationUrl(javax.ws.rs.core.UriInfo uriInfo)

realmOAuth2DeviceVerificationAction

public static URI realmOAuth2DeviceVerificationAction(URI baseUri,
                                                      String realmName)

oauth2DeviceAuthUrl

public static javax.ws.rs.core.UriBuilder oauth2DeviceAuthUrl(javax.ws.rs.core.UriBuilder baseUriBuilder)

oauth2DeviceVerificationCompletedUrl

public static javax.ws.rs.core.UriBuilder oauth2DeviceVerificationCompletedUrl(javax.ws.rs.core.UriInfo baseUri)

denyOAuth2DeviceAuthorization

public static javax.ws.rs.core.Response denyOAuth2DeviceAuthorization(org.keycloak.sessions.AuthenticationSessionModel authSession,
                                                                      org.keycloak.protocol.LoginProtocol.Error error,
                                                                      org.keycloak.models.KeycloakSession session)

approveOAuth2DeviceAuthorization

public static javax.ws.rs.core.Response approveOAuth2DeviceAuthorization(org.keycloak.sessions.AuthenticationSessionModel authSession,
                                                                         org.keycloak.models.AuthenticatedClientSessionModel clientSession,
                                                                         org.keycloak.models.KeycloakSession session)

isOAuth2DeviceVerificationFlow

public static boolean isOAuth2DeviceVerificationFlow(org.keycloak.sessions.AuthenticationSessionModel authSession)

getDeviceByDeviceCode

public static org.keycloak.models.OAuth2DeviceCodeModel getDeviceByDeviceCode(org.keycloak.models.KeycloakSession session,
                                                                              org.keycloak.models.RealmModel realm,
                                                                              String deviceCode)

removeDeviceByDeviceCode

public static void removeDeviceByDeviceCode(org.keycloak.models.KeycloakSession session,
                                            String deviceCode)

removeDeviceByUserCode

public static void removeDeviceByUserCode(org.keycloak.models.KeycloakSession session,
                                          org.keycloak.models.RealmModel realm,
                                          String userCode)

isPollingAllowed

public static boolean isPollingAllowed(org.keycloak.models.KeycloakSession session,
                                       org.keycloak.models.OAuth2DeviceCodeModel deviceCodeModel)

approveUserCode

public static boolean approveUserCode(org.keycloak.models.KeycloakSession session,
                                      org.keycloak.models.RealmModel realm,
                                      String userCode,
                                      String userSessionId,
                                      Map<String,String> additionalParams)

denyUserCode

public static boolean denyUserCode(org.keycloak.models.KeycloakSession session,
                                   org.keycloak.models.RealmModel realm,
                                   String userCode)

oauth2DeviceFlow

public javax.ws.rs.core.Response oauth2DeviceFlow()