software.amazon.awssdk.services.ssooidc.model

Interface CreateTokenRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>, SdkBuilder<CreateTokenRequest.Builder,CreateTokenRequest>, SdkPojo, SdkRequest.Builder, SsoOidcRequest.Builder

Enclosing class:

CreateTokenRequest

public static interface CreateTokenRequest.Builder
extends SsoOidcRequest.Builder, SdkPojo, CopyableBuilder<CreateTokenRequest.Builder,CreateTokenRequest>

Method Summary

Modifier and Type	Method and Description
CreateTokenRequest.Builder	clientId(String clientId) The unique identifier string for each client.
CreateTokenRequest.Builder	clientSecret(String clientSecret) A secret string generated for the client.
CreateTokenRequest.Builder	code(String code) The authorization code received from the authorization service.
CreateTokenRequest.Builder	deviceCode(String deviceCode) Used only when calling this API for the device code grant type.
CreateTokenRequest.Builder	grantType(String grantType) Supports grant types for the authorization code, refresh token, and device code request.
CreateTokenRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTokenRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateTokenRequest.Builder	redirectUri(String redirectUri) The location of the application that will receive the authorization code.
CreateTokenRequest.Builder	refreshToken(String refreshToken) Currently, refreshToken is not yet implemented and is not supported.
CreateTokenRequest.Builder	scope(Collection<String> scope) The list of scopes that is defined by the client.
CreateTokenRequest.Builder	scope(String... scope) The list of scopes that is defined by the client.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

clientId

CreateTokenRequest.Builder clientId(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.

clientSecret

CreateTokenRequest.Builder clientSecret(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.

grantType

CreateTokenRequest.Builder grantType(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.

deviceCode

CreateTokenRequest.Builder deviceCode(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.

code

CreateTokenRequest.Builder code(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.

refreshToken

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

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.

scope

CreateTokenRequest.Builder scope(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.

scope

CreateTokenRequest.Builder scope(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.

redirectUri

CreateTokenRequest.Builder redirectUri(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.

overrideConfiguration

CreateTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder