Class OpenIdConnectGroupConfiguration

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

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

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

See Also:

  • Method Details

    • groupClaim

      public final String groupClaim()

      The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

      Returns:
      The token claim that you want Verified Permissions to interpret as group membership. For example, groups.

    • groupEntityType

      public final String groupEntityType()

      The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

      Returns:
      The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.

    • toBuilder

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

    • builder

      public static OpenIdConnectGroupConfiguration.Builder builder()

    • serializableBuilderClass

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