Class CreateOAuth2TokenResponseBody

java.lang.Object
software.amazon.awssdk.services.signin.model.CreateOAuth2TokenResponseBody
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CreateOAuth2TokenResponseBody.Builder,CreateOAuth2TokenResponseBody>
@Generated("software.amazon.awssdk:codegen") public final class CreateOAuth2TokenResponseBody extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreateOAuth2TokenResponseBody.Builder,CreateOAuth2TokenResponseBody>

Response body payload for CreateOAuth2Token operation

The response content depends on the grant_type from the request:

  • grant_type=authorization_code: Returns all fields including refresh_token and id_token
  • grant_type=refresh_token: Returns access_token, token_type, expires_in, refresh_token (no id_token)
See Also:

  • Method Details

    • accessToken

      public final AccessToken accessToken()

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

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

    • tokenType

      public final String tokenType()

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

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

    • expiresIn

      public final Integer expiresIn()

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

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

    • refreshToken

      public final String refreshToken()

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

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

    • idToken

      public final 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

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

    • toBuilder

      public CreateOAuth2TokenResponseBody.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateOAuth2TokenResponseBody.Builder,CreateOAuth2TokenResponseBody>
      Returns:
      a builder for type T

    • builder

      public static CreateOAuth2TokenResponseBody.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOAuth2TokenResponseBody.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.