Class OpenIdConnectTokenSelection

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

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

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

See Also:

  • Method Details

    • accessTokenOnly

      public final OpenIdConnectAccessTokenConfiguration accessTokenOnly()

      The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

      Returns:
      The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    • identityTokenOnly

      public final OpenIdConnectIdentityTokenConfiguration identityTokenOnly()

      The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

      Returns:
      The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    • toBuilder

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

    • builder

      public static OpenIdConnectTokenSelection.Builder builder()

    • serializableBuilderClass

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

    • fromAccessTokenOnly

      public static OpenIdConnectTokenSelection fromAccessTokenOnly(OpenIdConnectAccessTokenConfiguration accessTokenOnly)
      Create an instance of this class with accessTokenOnly() initialized to the given value.

      The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

      Parameters:
      accessTokenOnly - The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    • fromAccessTokenOnly

      public static OpenIdConnectTokenSelection fromAccessTokenOnly(Consumer<OpenIdConnectAccessTokenConfiguration.Builder> accessTokenOnly)
      Create an instance of this class with accessTokenOnly() initialized to the given value.

      The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

      Parameters:
      accessTokenOnly - The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.

    • fromIdentityTokenOnly

      public static OpenIdConnectTokenSelection fromIdentityTokenOnly(OpenIdConnectIdentityTokenConfiguration identityTokenOnly)
      Create an instance of this class with identityTokenOnly() initialized to the given value.

      The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

      Parameters:
      identityTokenOnly - The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    • fromIdentityTokenOnly

      public static OpenIdConnectTokenSelection fromIdentityTokenOnly(Consumer<OpenIdConnectIdentityTokenConfiguration.Builder> identityTokenOnly)
      Create an instance of this class with identityTokenOnly() initialized to the given value.

      The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

      Parameters:
      identityTokenOnly - The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.

    • type

      public OpenIdConnectTokenSelection.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be OpenIdConnectTokenSelection.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be OpenIdConnectTokenSelection.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.