Class OidcJwtConfiguration

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

A structure that describes configuration settings for a trusted token issuer that supports OpenID Connect (OIDC) and JSON Web Tokens (JWTs).

See Also:

  • Method Details

    • issuerUrl

      public final String issuerUrl()

      The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

      Returns:
      The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

    • claimAttributePath

      public final String claimAttributePath()

      The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

      Returns:
      The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

    • identityStoreAttributePath

      public final String identityStoreAttributePath()

      The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

      Returns:
      The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

    • jwksRetrievalOption

      public final JwksRetrievalOption jwksRetrievalOption()

      The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

      If the service returns an enum value that is not available in the current SDK version, jwksRetrievalOption will return JwksRetrievalOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jwksRetrievalOptionAsString().

      Returns:
      The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
      See Also:

    • jwksRetrievalOptionAsString

      public final String jwksRetrievalOptionAsString()

      The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

      If the service returns an enum value that is not available in the current SDK version, jwksRetrievalOption will return JwksRetrievalOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jwksRetrievalOptionAsString().

      Returns:
      The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.
      See Also:

    • toBuilder

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

    • builder

      public static OidcJwtConfiguration.Builder builder()

    • serializableBuilderClass

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