All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTokenRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  CreateTokenRequest ()

• Method Summary

  All Methods

  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.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    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

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • CreateTokenRequest

    public CreateTokenRequest()

• Method Detail

  • setClientId

    public void setClientId(String clientId)

    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

    Parameters:

    clientId - The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

  • getClientId

    public String getClientId()

    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

    Returns:

    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

  • withClientId

    public CreateTokenRequest withClientId(String clientId)

    The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

    Parameters:

    clientId - The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setClientSecret

    public void setClientSecret(String clientSecret)

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    Parameters:

    clientSecret - A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

  • getClientSecret

    public String getClientSecret()

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    Returns:

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

  • withClientSecret

    public CreateTokenRequest withClientSecret(String clientSecret)

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    Parameters:

    clientSecret - A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setGrantType

    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.

    Parameters:

    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.

  • getGrantType

    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.

    Returns:

    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.

  • withGrantType

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setDeviceCode

    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.

    Parameters:

    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.

  • getDeviceCode

    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.

    Returns:

    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.

  • withDeviceCode

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setCode

    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.

    Parameters:

    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.

  • getCode

    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.

    Returns:

    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.

  • withCode

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setRefreshToken

    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.

    Parameters:

    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.

  • getRefreshToken

    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.

    Returns:

    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.

  • withRefreshToken

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getScope

    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.

    Returns:

    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.

  • setScope

    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.

    Parameters:

    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.

  • withScope

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withScope

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setRedirectUri

    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.

    Parameters:

    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.

  • getRedirectUri

    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.

    Returns:

    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.

  • withRedirectUri

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setCodeVerifier

    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.

    Parameters:

    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.

  • getCodeVerifier

    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.

    Returns:

    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.

  • withCodeVerifier

    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.

    Parameters:

    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.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public String toString()

    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public CreateTokenRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()