Interface CreateTokenWithIamResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>, SdkBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>, SdkPojo, SdkResponse.Builder, SsoOidcResponse.Builder
Enclosing class:
CreateTokenWithIamResponse
@Mutable @NotThreadSafe public static interface CreateTokenWithIamResponse.Builder extends SsoOidcResponse.Builder, SdkPojo, CopyableBuilder<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>

  • Method Details

    • accessToken

      CreateTokenWithIamResponse.Builder accessToken(String accessToken)

      A bearer token to access Amazon Web Services accounts and applications assigned to a user.

      Parameters:
      accessToken - A bearer token to access Amazon Web Services accounts and applications assigned to a user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenType

      CreateTokenWithIamResponse.Builder tokenType(String tokenType)

      Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

      Parameters:
      tokenType - Used to notify the requester that the returned token is an access token. The supported token type is Bearer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiresIn

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

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • idToken

      CreateTokenWithIamResponse.Builder idToken(String idToken)

      A JSON Web Token (JWT) that identifies the user associated with the issued access token.

      Parameters:
      idToken - A JSON Web Token (JWT) that identifies the user associated with the issued access token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuedTokenType

      CreateTokenWithIamResponse.Builder issuedTokenType(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scope

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

      Parameters:
      scope - The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scope

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

      Parameters:
      scope - The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsAdditionalDetails

      CreateTokenWithIamResponse.Builder awsAdditionalDetails(AwsAdditionalDetails awsAdditionalDetails)

      A structure containing information from the idToken. Only the identityContext is in it, which is a value extracted from the idToken. This provides direct access to identity information without requiring JWT parsing.

      Parameters:
      awsAdditionalDetails - A structure containing information from the idToken. Only the identityContext is in it, which is a value extracted from the idToken. This provides direct access to identity information without requiring JWT parsing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsAdditionalDetails

      default CreateTokenWithIamResponse.Builder awsAdditionalDetails(Consumer<AwsAdditionalDetails.Builder> awsAdditionalDetails)

      A structure containing information from the idToken. Only the identityContext is in it, which is a value extracted from the idToken. This provides direct access to identity information without requiring JWT parsing.

      This is a convenience method that creates an instance of the AwsAdditionalDetails.Builder avoiding the need to create one manually via AwsAdditionalDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to awsAdditionalDetails(AwsAdditionalDetails).

      Parameters:
      awsAdditionalDetails - a consumer that will call methods on AwsAdditionalDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: