Class: Aws::VerifiedPermissions::Types::UpdateOpenIdConnectGroupConfiguration

Inherits:

Struct

Object
Struct
Aws::VerifiedPermissions::Types::UpdateOpenIdConnectGroupConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-verifiedpermissions/types.rb

Overview

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 [UpdateOpenIdConnectConfiguration] structure, which is a parameter to [UpdateIdentitySource].

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateOpenIdConnectConfiguration.html [2]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdateIdentitySource.html

Constant Summary collapse

SENSITIVE =

[:group_claim, :group_entity_type]

Instance Attribute Summary collapse

#group_claim ⇒ String

The token claim that you want Verified Permissions to interpret as group membership.
#group_entity_type ⇒ String

The policy store entity type that you want to map your users’ group claim to.

Instance Attribute Details

#group_claim ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 4130

class UpdateOpenIdConnectGroupConfiguration < Struct.new(
  :group_claim,
  :group_entity_type)
  SENSITIVE = [:group_claim, :group_entity_type]
  include Aws::Structure
end

#group_entity_type ⇒ `String`

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.