2.233.0

interface OpenIdConnectGroupConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.VerifiedPermissions.Mixins.CfnIdentitySourcePropsMixin.OpenIdConnectGroupConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsverifiedpermissions/mixins#CfnIdentitySourcePropsMixin_OpenIdConnectGroupConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.verifiedpermissions.mixins.CfnIdentitySourcePropsMixin.OpenIdConnectGroupConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_verifiedpermissions.mixins.CfnIdentitySourcePropsMixin.OpenIdConnectGroupConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_verifiedpermissions » mixins » CfnIdentitySourcePropsMixin » OpenIdConnectGroupConfigurationProperty

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as verifiedpermissions_mixins } from '@aws-cdk/mixins-preview/aws-verifiedpermissions';
const openIdConnectGroupConfigurationProperty: verifiedpermissions_mixins.CfnIdentitySourcePropsMixin.OpenIdConnectGroupConfigurationProperty = {
  groupClaim: 'groupClaim',
  groupEntityType: 'groupEntityType',
};

Properties

NameTypeDescription
groupClaim?stringThe token claim that you want Verified Permissions to interpret as group membership.
groupEntityType?stringThe policy store entity type that you want to map your users' group claim to.

groupClaim?

Type: string (optional)

The token claim that you want Verified Permissions to interpret as group membership.

For example, groups .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectgroupconfiguration-groupclaim

groupEntityType?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectgroupconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectgroupconfiguration-groupentitytype

← PreviousNext →