Class OAuth2DeviceAuthorizationConsentAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationConsentAuthenticationToken

org.springframework.security.oauth2.server.authorization.authentication.OAuth2DeviceAuthorizationConsentAuthenticationToken

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

public class OAuth2DeviceAuthorizationConsentAuthenticationToken
extends OAuth2AuthorizationConsentAuthenticationToken

An Authentication implementation for the Device Authorization Consent used in the OAuth 2.0 Device Authorization Grant.

Since:

7.0

See Also:

• AbstractAuthenticationToken
• OAuth2DeviceAuthorizationConsentAuthenticationProvider
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

Nested classes/interfaces inherited from interface Authentication

Authentication.Builder<B>

Constructor Summary

Constructors

Constructor	Description
OAuth2DeviceAuthorizationConsentAuthenticationToken(String authorizationUri, String clientId, Authentication principal, String userCode, String state, @Nullable Set<String> authorizedScopes, @Nullable Map<String,Object> additionalParameters)	Constructs an OAuth2DeviceAuthorizationConsentAuthenticationToken using the provided parameters.
OAuth2DeviceAuthorizationConsentAuthenticationToken(String authorizationUri, String clientId, Authentication principal, String userCode, String state, @Nullable Set<String> requestedScopes, @Nullable Set<String> authorizedScopes)	Constructs an OAuth2DeviceAuthorizationConsentAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
@Nullable Set<String>	getRequestedScopes()	Returns the requested scopes.
String	getUserCode()	Returns the user code.

Methods inherited from class OAuth2AuthorizationConsentAuthenticationToken

getAdditionalParameters, getAuthorizationUri, getClientId, getCredentials, getPrincipal, getScopes, getState

Methods inherited from class AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Authentication

toBuilder

Methods inherited from interface Principal

implies

Constructor Details

OAuth2DeviceAuthorizationConsentAuthenticationToken

public OAuth2DeviceAuthorizationConsentAuthenticationToken(String authorizationUri,
 String clientId,
 Authentication principal,
 String userCode,
 String state,
 @Nullable Set<String> authorizedScopes,
 @Nullable Map<String,Object> additionalParameters)

Constructs an OAuth2DeviceAuthorizationConsentAuthenticationToken using the provided parameters.

Parameters:

authorizationUri - the authorization URI

clientId - the client identifier

principal - the Principal (Resource Owner)

userCode - the user code associated with the device authorization response

state - the state

authorizedScopes - the authorized scope(s)

additionalParameters - the additional parameters

OAuth2DeviceAuthorizationConsentAuthenticationToken

public OAuth2DeviceAuthorizationConsentAuthenticationToken(String authorizationUri,
 String clientId,
 Authentication principal,
 String userCode,
 String state,
 @Nullable Set<String> requestedScopes,
 @Nullable Set<String> authorizedScopes)

Constructs an OAuth2DeviceAuthorizationConsentAuthenticationToken using the provided parameters.

Parameters:

authorizationUri - the authorization URI

clientId - the client identifier

principal - the Principal (Resource Owner)

userCode - the user code associated with the device authorization response

state - the state

requestedScopes - the requested scope(s)

authorizedScopes - the authorized scope(s)

Method Details

getUserCode

public String getUserCode()

Returns the user code.

Returns:

the user code

getRequestedScopes

public @Nullable Set<String> getRequestedScopes()

Returns the requested scopes.

Returns:

the requested scopes, or null if not available