Class OpenIdConnectIdentityTokenConfiguration

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

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

See Also:

  • Method Details

    • principalIdClaim

      public final String principalIdClaim()

      The claim that determines the principal in OIDC access tokens. For example, sub.

      Returns:
      The claim that determines the principal in OIDC access tokens. For example, sub.

    • hasClientIds

      public final boolean hasClientIds()
      For responses, this returns true if the service returned a value for the ClientIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • clientIds

      public final List<String> clientIds()

      The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasClientIds() method.

      Returns:
      The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.

    • toBuilder

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

    • builder

      public static OpenIdConnectIdentityTokenConfiguration.Builder builder()

    • serializableBuilderClass

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