@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateTokenRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateTokenRequest() |
Modifier and Type | Method and Description |
---|---|
CreateTokenRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientId()
The unique identifier string for the client or application.
|
String |
getClientSecret()
A secret string generated for the client.
|
String |
getCode()
Used only when calling this API for the Authorization Code grant type.
|
String |
getCodeVerifier()
Used only when calling this API for the Authorization Code grant type.
|
String |
getDeviceCode()
Used only when calling this API for the Device Code grant type.
|
String |
getGrantType()
Supports the following OAuth grant types: Device Code and Refresh Token.
|
String |
getRedirectUri()
Used only when calling this API for the Authorization Code grant type.
|
String |
getRefreshToken()
Used only when calling this API for the Refresh Token grant type.
|
List<String> |
getScope()
The list of scopes for which authorization is requested.
|
int |
hashCode() |
void |
setClientId(String clientId)
The unique identifier string for the client or application.
|
void |
setClientSecret(String clientSecret)
A secret string generated for the client.
|
void |
setCode(String code)
Used only when calling this API for the Authorization Code grant type.
|
void |
setCodeVerifier(String codeVerifier)
Used only when calling this API for the Authorization Code grant type.
|
void |
setDeviceCode(String deviceCode)
Used only when calling this API for the Device Code grant type.
|
void |
setGrantType(String grantType)
Supports the following OAuth grant types: Device Code and Refresh Token.
|
void |
setRedirectUri(String redirectUri)
Used only when calling this API for the Authorization Code grant type.
|
void |
setRefreshToken(String refreshToken)
Used only when calling this API for the Refresh Token grant type.
|
void |
setScope(Collection<String> scope)
The list of scopes for which authorization is requested.
|
String |
toString()
Returns a string representation of this object.
|
CreateTokenRequest |
withClientId(String clientId)
The unique identifier string for the client or application.
|
CreateTokenRequest |
withClientSecret(String clientSecret)
A secret string generated for the client.
|
CreateTokenRequest |
withCode(String code)
Used only when calling this API for the Authorization Code grant type.
|
CreateTokenRequest |
withCodeVerifier(String codeVerifier)
Used only when calling this API for the Authorization Code grant type.
|
CreateTokenRequest |
withDeviceCode(String deviceCode)
Used only when calling this API for the Device Code grant type.
|
CreateTokenRequest |
withGrantType(String grantType)
Supports the following OAuth grant types: Device Code and Refresh Token.
|
CreateTokenRequest |
withRedirectUri(String redirectUri)
Used only when calling this API for the Authorization Code grant type.
|
CreateTokenRequest |
withRefreshToken(String refreshToken)
Used only when calling this API for the Refresh Token grant type.
|
CreateTokenRequest |
withScope(Collection<String> scope)
The list of scopes for which authorization is requested.
|
CreateTokenRequest |
withScope(String... scope)
The list of scopes for which authorization is requested.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClientId(String clientId)
The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
clientId
- The unique identifier string for the client or application. This value comes from the result of the
RegisterClient API.public String getClientId()
The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
public CreateTokenRequest withClientId(String clientId)
The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
clientId
- The unique identifier string for the client or application. This value comes from the result of the
RegisterClient API.public void setClientSecret(String clientSecret)
A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
clientSecret
- A secret string generated for the client. This value should come from the persisted result of the
RegisterClient API.public String getClientSecret()
A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
public CreateTokenRequest withClientSecret(String clientSecret)
A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
clientSecret
- A secret string generated for the client. This value should come from the persisted result of the
RegisterClient API.public void setGrantType(String grantType)
Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
* Device Code - urn:ietf:params:oauth:grant-type:device_code
* Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
grantType
- Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following
values, depending on the grant type that you want:
Device Code - urn:ietf:params:oauth:grant-type:device_code
Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
public String getGrantType()
Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
* Device Code - urn:ietf:params:oauth:grant-type:device_code
* Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
Device Code - urn:ietf:params:oauth:grant-type:device_code
Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
public CreateTokenRequest withGrantType(String grantType)
Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
* Device Code - urn:ietf:params:oauth:grant-type:device_code
* Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
grantType
- Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following
values, depending on the grant type that you want:
Device Code - urn:ietf:params:oauth:grant-type:device_code
Refresh Token - refresh_token
For information about how to obtain the device code, see the StartDeviceAuthorization topic.
public void setDeviceCode(String deviceCode)
Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
deviceCode
- Used only when calling this API for the Device Code grant type. This short-term code is used to identify
this authorization request. This comes from the result of the StartDeviceAuthorization API.public String getDeviceCode()
Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
public CreateTokenRequest withDeviceCode(String deviceCode)
Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
deviceCode
- Used only when calling this API for the Device Code grant type. This short-term code is used to identify
this authorization request. This comes from the result of the StartDeviceAuthorization API.public void setCode(String code)
Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
code
- Used only when calling this API for the Authorization Code grant type. The short-term code is used to
identify this authorization request. This grant type is currently unsupported for the CreateToken
API.public String getCode()
Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
public CreateTokenRequest withCode(String code)
Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
code
- Used only when calling this API for the Authorization Code grant type. The short-term code is used to
identify this authorization request. This grant type is currently unsupported for the CreateToken
API.public void setRefreshToken(String refreshToken)
Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
refreshToken
- Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term
tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
public String getRefreshToken()
Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
public CreateTokenRequest withRefreshToken(String refreshToken)
Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
refreshToken
- Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term
tokens, such as the access token, that might expire.
For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
public List<String> getScope()
The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
public void setScope(Collection<String> scope)
The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
scope
- The list of scopes for which authorization is requested. The access token that is issued is limited to the
scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that
are configured for the client during the call to RegisterClient.public CreateTokenRequest withScope(String... scope)
The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
NOTE: This method appends the values to the existing list (if any). Use
setScope(java.util.Collection)
or withScope(java.util.Collection)
if you want to override the
existing values.
scope
- The list of scopes for which authorization is requested. The access token that is issued is limited to the
scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that
are configured for the client during the call to RegisterClient.public CreateTokenRequest withScope(Collection<String> scope)
The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
scope
- The list of scopes for which authorization is requested. The access token that is issued is limited to the
scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that
are configured for the client during the call to RegisterClient.public void setRedirectUri(String redirectUri)
Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
redirectUri
- Used only when calling this API for the Authorization Code grant type. This value specifies the location
of the client or application that has registered to receive the authorization code.public String getRedirectUri()
Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
public CreateTokenRequest withRedirectUri(String redirectUri)
Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
redirectUri
- Used only when calling this API for the Authorization Code grant type. This value specifies the location
of the client or application that has registered to receive the authorization code.public void setCodeVerifier(String codeVerifier)
Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
codeVerifier
- Used only when calling this API for the Authorization Code grant type. This value is generated by the
client and presented to validate the original code challenge value the client passed at authorization
time.public String getCodeVerifier()
Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
public CreateTokenRequest withCodeVerifier(String codeVerifier)
Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
codeVerifier
- Used only when calling this API for the Authorization Code grant type. This value is generated by the
client and presented to validate the original code challenge value the client passed at authorization
time.public String toString()
toString
in class Object
Object.toString()
public CreateTokenRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()