Class CreateOAuth2TokenRequestBody

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

Request body payload for CreateOAuth2Token operation

The operation type is determined by the grant_type parameter:

  • grant_type=authorization_code: Requires code, redirect_uri, code_verifier
  • grant_type=refresh_token: Requires refresh_token
See Also:

  • Method Details

    • clientId

      public final String clientId()

      The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

      Returns:
      The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

    • grantType

      public final String grantType()

      OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"

      Returns:
      OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"

    • code

      public final String code()

      The authorization code received from /v1/authorize Required only when grant_type=authorization_code

      Returns:
      The authorization code received from /v1/authorize Required only when grant_type=authorization_code

    • redirectUri

      public final String redirectUri()

      The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

      Returns:
      The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

    • codeVerifier

      public final String codeVerifier()

      PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

      Returns:
      PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

    • refreshToken

      public final String refreshToken()

      The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

      Returns:
      The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

    • toBuilder

      public CreateOAuth2TokenRequestBody.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<CreateOAuth2TokenRequestBody.Builder,CreateOAuth2TokenRequestBody>
      Returns:
      a builder for type T

    • builder

      public static CreateOAuth2TokenRequestBody.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOAuth2TokenRequestBody.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.