Interface CreateOAuth2TokenResponseBody.Builder

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

  • Method Details

    • accessToken

      CreateOAuth2TokenResponseBody.Builder accessToken(AccessToken accessToken)

      Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh

      Parameters:
      accessToken - Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessToken

      default CreateOAuth2TokenResponseBody.Builder accessToken(Consumer<AccessToken.Builder> accessToken)

      Scoped-down AWS credentials (15 minute duration) Present for both authorization code redemption and token refresh

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

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

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

    • tokenType

      CreateOAuth2TokenResponseBody.Builder tokenType(String tokenType)

      Token type indicating this is AWS SigV4 credentials Value is "aws_sigv4" for both flows

      Parameters:
      tokenType - Token type indicating this is AWS SigV4 credentials Value is "aws_sigv4" for both flows
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiresIn

      CreateOAuth2TokenResponseBody.Builder expiresIn(Integer expiresIn)

      Time to expiry in seconds (maximum 900) Present for both authorization code redemption and token refresh

      Parameters:
      expiresIn - Time to expiry in seconds (maximum 900) Present for both authorization code redemption and token refresh
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshToken

      CreateOAuth2TokenResponseBody.Builder refreshToken(String refreshToken)

      Encrypted refresh token with cnf.jkt (SHA-256 thumbprint of presented jwk) Always present in responses (required for both flows)

      Parameters:
      refreshToken - Encrypted refresh token with cnf.jkt (SHA-256 thumbprint of presented jwk) Always present in responses (required for both flows)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idToken

      CreateOAuth2TokenResponseBody.Builder idToken(String idToken)

      ID token containing user identity information Present only in authorization code redemption response (grant_type=authorization_code) Not included in token refresh responses

      Parameters:
      idToken - ID token containing user identity information Present only in authorization code redemption response (grant_type=authorization_code) Not included in token refresh responses
      Returns:
      Returns a reference to this object so that method calls can be chained together.