com.amazonaws.services.ssooidc.model

Class CreateTokenWithIAMResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.ssooidc.model.CreateTokenWithIAMResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTokenWithIAMResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateTokenWithIAMResult()

Method Summary

Modifier and Type	Method and Description
CreateTokenWithIAMResult	clone()
boolean	equals(Object obj)
String	getAccessToken() A bearer token to access Amazon Web Services accounts and applications assigned to a user.
Integer	getExpiresIn() Indicates the time in seconds when an access token will expire.
String	getIdToken() A JSON Web Token (JWT) that identifies the user associated with the issued access token.
String	getIssuedTokenType() Indicates the type of tokens that are issued by IAM Identity Center.
String	getRefreshToken() A token that, if present, can be used to refresh a previously issued access token that might have expired.
List<String>	getScope() The list of scopes for which authorization is granted.
String	getTokenType() Used to notify the requester that the returned token is an access token.
int	hashCode()
void	setAccessToken(String accessToken) A bearer token to access Amazon Web Services accounts and applications assigned to a user.
void	setExpiresIn(Integer expiresIn) Indicates the time in seconds when an access token will expire.
void	setIdToken(String idToken) A JSON Web Token (JWT) that identifies the user associated with the issued access token.
void	setIssuedTokenType(String issuedTokenType) Indicates the type of tokens that are issued by IAM Identity Center.
void	setRefreshToken(String refreshToken) A token that, if present, can be used to refresh a previously issued access token that might have expired.
void	setScope(Collection<String> scope) The list of scopes for which authorization is granted.
void	setTokenType(String tokenType) Used to notify the requester that the returned token is an access token.
String	toString() Returns a string representation of this object.
CreateTokenWithIAMResult	withAccessToken(String accessToken) A bearer token to access Amazon Web Services accounts and applications assigned to a user.
CreateTokenWithIAMResult	withExpiresIn(Integer expiresIn) Indicates the time in seconds when an access token will expire.
CreateTokenWithIAMResult	withIdToken(String idToken) A JSON Web Token (JWT) that identifies the user associated with the issued access token.
CreateTokenWithIAMResult	withIssuedTokenType(String issuedTokenType) Indicates the type of tokens that are issued by IAM Identity Center.
CreateTokenWithIAMResult	withRefreshToken(String refreshToken) A token that, if present, can be used to refresh a previously issued access token that might have expired.
CreateTokenWithIAMResult	withScope(Collection<String> scope) The list of scopes for which authorization is granted.
CreateTokenWithIAMResult	withScope(String... scope) The list of scopes for which authorization is granted.
CreateTokenWithIAMResult	withTokenType(String tokenType) Used to notify the requester that the returned token is an access token.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTokenWithIAMResult

public CreateTokenWithIAMResult()

Method Detail

setAccessToken

public void setAccessToken(String accessToken)

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

Parameters:

accessToken - A bearer token to access Amazon Web Services accounts and applications assigned to a user.

getAccessToken

public String getAccessToken()

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

Returns:

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

withAccessToken

public CreateTokenWithIAMResult withAccessToken(String accessToken)

A bearer token to access Amazon Web Services accounts and applications assigned to a user.

Parameters:

accessToken - A bearer token to access Amazon Web Services accounts and applications assigned to a user.

Returns:

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

setTokenType

public void setTokenType(String tokenType)

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

Parameters:

tokenType - Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

getTokenType

public String getTokenType()

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

Returns:

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

withTokenType

public CreateTokenWithIAMResult withTokenType(String tokenType)

Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

Parameters:

tokenType - Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

Returns:

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

setExpiresIn

public void setExpiresIn(Integer expiresIn)

Indicates the time in seconds when an access token will expire.

Parameters:

expiresIn - Indicates the time in seconds when an access token will expire.

getExpiresIn

public Integer getExpiresIn()

Indicates the time in seconds when an access token will expire.

Returns:

Indicates the time in seconds when an access token will expire.

withExpiresIn

public CreateTokenWithIAMResult withExpiresIn(Integer expiresIn)

Indicates the time in seconds when an access token will expire.

Parameters:

expiresIn - Indicates the time in seconds when an access token will expire.

Returns:

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

setRefreshToken

public void setRefreshToken(String refreshToken)

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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 - A token that, if present, can be used to refresh a previously issued access token that might have expired.

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

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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:

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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 CreateTokenWithIAMResult withRefreshToken(String refreshToken)

A token that, if present, can be used to refresh a previously issued access token that might have expired.

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 - A token that, if present, can be used to refresh a previously issued access token that might have expired.

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.

setIdToken

public void setIdToken(String idToken)

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

Parameters:

idToken - A JSON Web Token (JWT) that identifies the user associated with the issued access token.

getIdToken

public String getIdToken()

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

Returns:

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

withIdToken

public CreateTokenWithIAMResult withIdToken(String idToken)

A JSON Web Token (JWT) that identifies the user associated with the issued access token.

Parameters:

idToken - A JSON Web Token (JWT) that identifies the user associated with the issued access token.

Returns:

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

setIssuedTokenType

public void setIssuedTokenType(String issuedTokenType)

Indicates the type of tokens that are issued by IAM Identity Center. 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:

issuedTokenType - Indicates the type of tokens that are issued by IAM Identity Center. 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

getIssuedTokenType

public String getIssuedTokenType()

Indicates the type of tokens that are issued by IAM Identity Center. 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:

Indicates the type of tokens that are issued by IAM Identity Center. 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

withIssuedTokenType

public CreateTokenWithIAMResult withIssuedTokenType(String issuedTokenType)

Indicates the type of tokens that are issued by IAM Identity Center. 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:

issuedTokenType - Indicates the type of tokens that are issued by IAM Identity Center. 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.

getScope

public List<String> getScope()

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

Returns:

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

setScope

public void setScope(Collection<String> scope)

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

Parameters:

scope - The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

withScope

public CreateTokenWithIAMResult withScope(String... scope)

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

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 granted. The access token that is issued is limited to the scopes that are granted.

Returns:

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

withScope

public CreateTokenWithIAMResult withScope(Collection<String> scope)

The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

Parameters:

scope - The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.

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

Overrides:

clone in class Object