software.amazon.awssdk.services.ssooidc.model

Interface CreateTokenResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreateTokenResponse.Builder,CreateTokenResponse>, SdkBuilder<CreateTokenResponse.Builder,CreateTokenResponse>, SdkPojo, SdkResponse.Builder, SsoOidcResponse.Builder

Enclosing class:

CreateTokenResponse

public static interface CreateTokenResponse.Builder
extends SsoOidcResponse.Builder, SdkPojo, CopyableBuilder<CreateTokenResponse.Builder,CreateTokenResponse>

Method Summary

Modifier and Type	Method and Description
CreateTokenResponse.Builder	accessToken(String accessToken) An opaque token to access IAM Identity Center resources assigned to a user.
CreateTokenResponse.Builder	expiresIn(Integer expiresIn) Indicates the time in seconds when an access token will expire.
CreateTokenResponse.Builder	idToken(String idToken) Currently, idToken is not yet implemented and is not supported.
CreateTokenResponse.Builder	refreshToken(String refreshToken) Currently, refreshToken is not yet implemented and is not supported.
CreateTokenResponse.Builder	tokenType(String tokenType) Used to notify the client that the returned token is an access token.

Methods inherited from interface software.amazon.awssdk.services.ssooidc.model.SsoOidcResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

accessToken

CreateTokenResponse.Builder accessToken(String accessToken)

An opaque token to access IAM Identity Center resources assigned to a user.

Parameters:

accessToken - An opaque token to access IAM Identity Center resources assigned to a user.

Returns:

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

tokenType

CreateTokenResponse.Builder tokenType(String tokenType)

Used to notify the client that the returned token is an access token. The supported type is BearerToken.

Parameters:

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

Returns:

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

expiresIn

CreateTokenResponse.Builder expiresIn(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.

refreshToken

CreateTokenResponse.Builder refreshToken(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.

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

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

Returns:

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

idToken

CreateTokenResponse.Builder idToken(String idToken)

Currently, idToken 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 identifier of the user that associated with the access token, if present.

Parameters:

idToken - Currently, idToken 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 identifier of the user that associated with the access token, if present.

Returns:

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