com.amazonaws.services.ssooidc.model

Class CreateTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ssooidc.model.CreateTokenRequest

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

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 each client.
String	getClientSecret() A secret string generated for the client.
String	getCode() The authorization code received from the authorization service.
String	getDeviceCode() Used only when calling this API for the device code grant type.
String	getGrantType() Supports grant types for the authorization code, refresh token, and device code request.
String	getRedirectUri() The location of the application that will receive the authorization code.
String	getRefreshToken() Currently, refreshToken is not yet implemented and is not supported.
List<String>	getScope() The list of scopes that is defined by the client.
int	hashCode()
void	setClientId(String clientId) The unique identifier string for each client.
void	setClientSecret(String clientSecret) A secret string generated for the client.
void	setCode(String code) The authorization code received from the authorization service.
void	setDeviceCode(String deviceCode) Used only when calling this API for the device code grant type.
void	setGrantType(String grantType) Supports grant types for the authorization code, refresh token, and device code request.
void	setRedirectUri(String redirectUri) The location of the application that will receive the authorization code.
void	setRefreshToken(String refreshToken) Currently, refreshToken is not yet implemented and is not supported.
void	setScope(Collection<String> scope) The list of scopes that is defined by the client.
String	toString() Returns a string representation of this object.
CreateTokenRequest	withClientId(String clientId) The unique identifier string for each client.
CreateTokenRequest	withClientSecret(String clientSecret) A secret string generated for the client.
CreateTokenRequest	withCode(String code) The authorization code received from the authorization service.
CreateTokenRequest	withDeviceCode(String deviceCode) Used only when calling this API for the device code grant type.
CreateTokenRequest	withGrantType(String grantType) Supports grant types for the authorization code, refresh token, and device code request.
CreateTokenRequest	withRedirectUri(String redirectUri) The location of the application that will receive the authorization code.
CreateTokenRequest	withRefreshToken(String refreshToken) Currently, refreshToken is not yet implemented and is not supported.
CreateTokenRequest	withScope(Collection<String> scope) The list of scopes that is defined by the client.
CreateTokenRequest	withScope(String... scope) The list of scopes that is defined by the client.

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 each client. This value should come from the persisted result of the RegisterClient API.

Parameters:

clientId - The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

getClientId

public String getClientId()

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

Returns:

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

withClientId

public CreateTokenRequest withClientId(String clientId)

The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

Parameters:

clientId - The unique identifier string for each 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.

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 grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

Parameters:

grantType - Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

getGrantType

public String getGrantType()

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

Returns:

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

withGrantType

public CreateTokenRequest withGrantType(String grantType)

Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

For information about how to obtain the device code, see the StartDeviceAuthorization topic.

Parameters:

grantType - Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:

urn:ietf:params:oauth:grant-type:device_code

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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to 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 authentication attempt. This should come from an in-memory reference to 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)

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

Parameters:

code - The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

getCode

public String getCode()

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

Returns:

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

withCode

public CreateTokenRequest withCode(String code)

The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

Parameters:

code - The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

Returns:

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

setRefreshToken

public void setRefreshToken(String refreshToken)

Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

Parameters:

refreshToken - Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

getRefreshToken

public String getRefreshToken()

Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

Returns:

Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

withRefreshToken

public CreateTokenRequest withRefreshToken(String refreshToken)

Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

Parameters:

refreshToken - Currently, refreshToken is not yet implemented and is not supported. 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.

The token used to obtain an access token in the event that the access token is invalid or expired.

Returns:

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

getScope

public List<String> getScope()

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Returns:

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

setScope

public void setScope(Collection<String> scope)

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Parameters:

scope - The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

withScope

public CreateTokenRequest withScope(String... scope)

The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

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 that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

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 that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Parameters:

scope - The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Returns:

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

setRedirectUri

public void setRedirectUri(String redirectUri)

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Parameters:

redirectUri - The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

getRedirectUri

public String getRedirectUri()

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Returns:

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

withRedirectUri

public CreateTokenRequest withRedirectUri(String redirectUri)

The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

Parameters:

redirectUri - The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

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()