com.amazonaws.services.ssooidc.model

Class CreateTokenWithIAMRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ssooidc.model.CreateTokenWithIAMRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTokenWithIAMRequest
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
CreateTokenWithIAMRequest()

Method Summary

Modifier and Type	Method and Description
CreateTokenWithIAMRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAssertion() Used only when calling this API for the JWT Bearer grant type.
String	getClientId() The unique identifier string for the client or application.
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	getGrantType() Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange.
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.
String	getRequestedTokenType() Used only when calling this API for the Token Exchange grant type.
List<String>	getScope() The list of scopes for which authorization is requested.
String	getSubjectToken() Used only when calling this API for the Token Exchange grant type.
String	getSubjectTokenType() Used only when calling this API for the Token Exchange grant type.
int	hashCode()
void	setAssertion(String assertion) Used only when calling this API for the JWT Bearer grant type.
void	setClientId(String clientId) The unique identifier string for the client or application.
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	setGrantType(String grantType) Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange.
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	setRequestedTokenType(String requestedTokenType) Used only when calling this API for the Token Exchange grant type.
void	setScope(Collection<String> scope) The list of scopes for which authorization is requested.
void	setSubjectToken(String subjectToken) Used only when calling this API for the Token Exchange grant type.
void	setSubjectTokenType(String subjectTokenType) Used only when calling this API for the Token Exchange grant type.
String	toString() Returns a string representation of this object.
CreateTokenWithIAMRequest	withAssertion(String assertion) Used only when calling this API for the JWT Bearer grant type.
CreateTokenWithIAMRequest	withClientId(String clientId) The unique identifier string for the client or application.
CreateTokenWithIAMRequest	withCode(String code) Used only when calling this API for the Authorization Code grant type.
CreateTokenWithIAMRequest	withCodeVerifier(String codeVerifier) Used only when calling this API for the Authorization Code grant type.
CreateTokenWithIAMRequest	withGrantType(String grantType) Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange.
CreateTokenWithIAMRequest	withRedirectUri(String redirectUri) Used only when calling this API for the Authorization Code grant type.
CreateTokenWithIAMRequest	withRefreshToken(String refreshToken) Used only when calling this API for the Refresh Token grant type.
CreateTokenWithIAMRequest	withRequestedTokenType(String requestedTokenType) Used only when calling this API for the Token Exchange grant type.
CreateTokenWithIAMRequest	withScope(Collection<String> scope) The list of scopes for which authorization is requested.
CreateTokenWithIAMRequest	withScope(String... scope) The list of scopes for which authorization is requested.
CreateTokenWithIAMRequest	withSubjectToken(String subjectToken) Used only when calling this API for the Token Exchange grant type.
CreateTokenWithIAMRequest	withSubjectTokenType(String subjectTokenType) Used only when calling this API for the Token Exchange grant type.

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

CreateTokenWithIAMRequest

public CreateTokenWithIAMRequest()

Method Detail

setClientId

public void setClientId(String clientId)

The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

Parameters:

clientId - The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

getClientId

public String getClientId()

The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

Returns:

The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

withClientId

public CreateTokenWithIAMRequest withClientId(String clientId)

The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

Parameters:

clientId - The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

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: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

* Authorization Code - authorization_code

* Refresh Token - refresh_token

* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

Parameters:

grantType - Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

Authorization Code - authorization_code

Refresh Token - refresh_token

JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

getGrantType

public String getGrantType()

Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

* Authorization Code - authorization_code

* Refresh Token - refresh_token

* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

Returns:

Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

Authorization Code - authorization_code

Refresh Token - refresh_token

JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

withGrantType

public CreateTokenWithIAMRequest withGrantType(String grantType)

Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

* Authorization Code - authorization_code

* Refresh Token - refresh_token

* JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

* Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

Parameters:

grantType - Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

Authorization Code - authorization_code

Refresh Token - refresh_token

JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

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. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

Parameters:

code - Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

getCode

public String getCode()

Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

Returns:

Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

withCode

public CreateTokenWithIAMRequest withCode(String code)

Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

Parameters:

code - Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

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 CreateTokenWithIAMRequest 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.

setAssertion

public void setAssertion(String assertion)

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

Parameters:

assertion - Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

getAssertion

public String getAssertion()

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

Returns:

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

withAssertion

public CreateTokenWithIAMRequest withAssertion(String assertion)

Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

Parameters:

assertion - Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

withScope

public CreateTokenWithIAMRequest 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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

Returns:

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

withScope

public CreateTokenWithIAMRequest 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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

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 CreateTokenWithIAMRequest 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.

setSubjectToken

public void setSubjectToken(String subjectToken)

Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

Parameters:

subjectToken - Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

getSubjectToken

public String getSubjectToken()

Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

Returns:

Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

withSubjectToken

public CreateTokenWithIAMRequest withSubjectToken(String subjectToken)

Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

Parameters:

subjectToken - Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

Returns:

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

setSubjectTokenType

public void setSubjectTokenType(String subjectTokenType)

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

Parameters:

subjectTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

getSubjectTokenType

public String getSubjectTokenType()

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

Returns:

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

withSubjectTokenType

public CreateTokenWithIAMRequest withSubjectTokenType(String subjectTokenType)

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

Parameters:

subjectTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

Returns:

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

setRequestedTokenType

public void setRequestedTokenType(String requestedTokenType)

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

Parameters:

requestedTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

getRequestedTokenType

public String getRequestedTokenType()

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

Returns:

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

withRequestedTokenType

public CreateTokenWithIAMRequest withRequestedTokenType(String requestedTokenType)

Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

* Access Token - urn:ietf:params:oauth:token-type:access_token

* Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

Parameters:

requestedTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:

Access Token - urn:ietf:params:oauth:token-type:access_token

Refresh Token - urn:ietf:params:oauth:token-type:refresh_token

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