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 Details

    • clientId

      CreateTokenRequest.Builder clientId(String clientId)

      The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.

      Parameters:
      clientId - The unique identifier string for the client or application. This value comes from the 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 the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:

      * Device Code - urn:ietf:params:oauth:grant-type:device_code

      * Refresh Token - refresh_token

      For information about how to obtain the device code, see the StartDeviceAuthorization topic.

      Parameters:
      grantType - Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:

      * Device Code - urn:ietf:params:oauth:grant-type:device_code

      * Refresh Token - refresh_token

      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 authorization request. This comes from 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 authorization request. This comes from 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)

      Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.

      Parameters:
      code - Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshToken

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

    • scope

      CreateTokenRequest.Builder scope(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 this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.

      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 this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
      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 for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.

      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 this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redirectUri

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

    • codeVerifier

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

    • overrideConfiguration

      CreateTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.