Class OidcTokenInfo

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

Contains OAuth token information returned from the identity provider, including access tokens, ID tokens, and PKCE parameters used for secure authentication.

See Also:

  • Method Details

    • codeVerifier

      public final String codeVerifier()

      The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.

      Returns:
      The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.

    • codeChallenge

      public final String codeChallenge()

      The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.

      Returns:
      The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.

    • accessToken

      public final String accessToken()

      The OAuth access token that can be used to access protected resources on behalf of the authenticated user.

      Returns:
      The OAuth access token that can be used to access protected resources on behalf of the authenticated user.

    • idToken

      public final String idToken()

      The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.

      Returns:
      The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.

    • refreshToken

      public final String refreshToken()

      The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.

      Returns:
      The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.

    • tokenType

      public final String tokenType()

      The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.

      Returns:
      The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.

    • expiresIn

      public final Long expiresIn()

      The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.

      Returns:
      The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.

    • toBuilder

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

    • builder

      public static OidcTokenInfo.Builder builder()

    • serializableBuilderClass

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