Class OAuth2DeviceAuthorizationResponse
java.lang.Object
org.springframework.security.oauth2.core.endpoint.OAuth2DeviceAuthorizationResponse
A representation of an OAuth 2.0 Device Authorization Response.
- Since:
- 6.1
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder forOAuth2DeviceAuthorizationResponse
. -
Method Summary
Modifier and TypeMethodDescriptionReturns the additional parameters returned in the response.Returns theDevice Code
.long
Returns the minimum amount of time (in seconds) that the client should wait between polling requests to the token endpoint.Returns theUser Code
.Returns the end-user verification URI.Returns the end-user verification URI that includes the user code.Returns a newOAuth2DeviceAuthorizationResponse.Builder
, initialized with the provided device code and user code values.with
(OAuth2DeviceCode deviceCode, OAuth2UserCode userCode) Returns a newOAuth2DeviceAuthorizationResponse.Builder
, initialized with the provided device code and user code.
-
Method Details
-
getDeviceCode
Returns theDevice Code
.- Returns:
- the
OAuth2DeviceCode
-
getUserCode
Returns theUser Code
.- Returns:
- the
OAuth2UserCode
-
getVerificationUri
Returns the end-user verification URI.- Returns:
- the end-user verification URI
-
getVerificationUriComplete
Returns the end-user verification URI that includes the user code.- Returns:
- the end-user verification URI that includes the user code
-
getInterval
public long getInterval()Returns the minimum amount of time (in seconds) that the client should wait between polling requests to the token endpoint.- Returns:
- the minimum amount of time between polling requests
-
getAdditionalParameters
Returns the additional parameters returned in the response.- Returns:
- a
Map
of the additional parameters returned in the response, may be empty.
-
with
Returns a newOAuth2DeviceAuthorizationResponse.Builder
, initialized with the provided device code and user code values.- Parameters:
deviceCode
- the value of the device codeuserCode
- the value of the user code- Returns:
- the
OAuth2DeviceAuthorizationResponse.Builder
-
with
public static OAuth2DeviceAuthorizationResponse.Builder with(OAuth2DeviceCode deviceCode, OAuth2UserCode userCode) Returns a newOAuth2DeviceAuthorizationResponse.Builder
, initialized with the provided device code and user code.- Parameters:
deviceCode
- theOAuth2DeviceCode
userCode
- theOAuth2UserCode
- Returns:
- the
OAuth2DeviceAuthorizationResponse.Builder
-