Package software.amazon.awssdk.services.ssooidc.model

Class CreateTokenWithIamResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse

software.amazon.awssdk.services.ssooidc.model.CreateTokenWithIamResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CreateTokenWithIamResponse
extends SsoOidcResponse
implements ToCopyableBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateTokenWithIamResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	A bearer token to access Amazon Web Services accounts and applications assigned to a user.
static CreateTokenWithIamResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expiresIn()	Indicates the time in seconds when an access token will expire.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasScope()	For responses, this returns true if the service returned a value for the Scope property.
String	idToken()	A JSON Web Token (JWT) that identifies the user associated with the issued access token.
String	issuedTokenType()	Indicates the type of tokens that are issued by IAM Identity Center.
String	refreshToken()	A token that, if present, can be used to refresh a previously issued access token that might have expired.
List<String>	scope()	The list of scopes for which authorization is granted.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTokenWithIamResponse.Builder>	serializableBuilderClass()
CreateTokenWithIamResponse.Builder	toBuilder()
String	tokenType()	Used to notify the requester that the returned token is an access token.
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accessToken

public final String accessToken()

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.

tokenType

public final String tokenType()

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.

expiresIn

public final Integer expiresIn()

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

Returns:

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

refreshToken

public final 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.

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.

idToken

public final String idToken()

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.

issuedTokenType

public final 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

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

hasScope

public final boolean hasScope()

For responses, this returns true if the service returned a value for the Scope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

scope

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScope() method.

Returns:

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

toBuilder

public CreateTokenWithIamResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CreateTokenWithIamResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTokenWithIamResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo