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

Interface CreateTokenWithIamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>, SdkBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>, SdkPojo, SdkRequest.Builder, SsoOidcRequest.Builder
Enclosing class:
CreateTokenWithIamRequest
public static interface CreateTokenWithIamRequest.Builder extends SsoOidcRequest.Builder, SdkPojo, CopyableBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>

  • Method Details

    • clientId

      CreateTokenWithIamRequest.Builder clientId(String clientId)

      The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

      Parameters:
      clientId - The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantType

      CreateTokenWithIamRequest.Builder grantType(String grantType)

      Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

      * Authorization Code - authorization_code

      * Refresh Token - refresh_token

      * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

      * Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

      Parameters:
      grantType - Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:

      * Authorization Code - authorization_code

      * Refresh Token - refresh_token

      * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer

      * Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange

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

    • code

      CreateTokenWithIamRequest.Builder code(String code)

      Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.

      Parameters:
      code - Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshToken

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

    • assertion

      CreateTokenWithIamRequest.Builder assertion(String assertion)

      Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.

      Parameters:
      assertion - Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      CreateTokenWithIamRequest.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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

      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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

      CreateTokenWithIamRequest.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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.

      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 the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redirectUri

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

    • subjectToken

      CreateTokenWithIamRequest.Builder subjectToken(String subjectToken)

      Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.

      Parameters:
      subjectToken - Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectTokenType

      CreateTokenWithIamRequest.Builder subjectTokenType(String subjectTokenType)

      Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

      * Access Token - urn:ietf:params:oauth:token-type:access_token

      Parameters:
      subjectTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:

      * Access Token - urn:ietf:params:oauth:token-type:access_token

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

    • requestedTokenType

      CreateTokenWithIamRequest.Builder requestedTokenType(String requestedTokenType)

      Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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:
      requestedTokenType - Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. 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.

    • codeVerifier

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

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

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