interface OpenIdConnectConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsverifiedpermissions#CfnIdentitySource_OpenIdConnectConfigurationProperty`
Java	`software.amazon.awscdk.services.verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty`
Python	`aws_cdk.aws_verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_verifiedpermissions` » `CfnIdentitySource` » `OpenIdConnectConfigurationProperty`

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities.

It specifies the issuer URL, token type that you want to use, and policy store entity details.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_verifiedpermissions as verifiedpermissions } from 'aws-cdk-lib';
const openIdConnectConfigurationProperty: verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty = {
  issuer: 'issuer',
  tokenSelection: {
    accessTokenOnly: {
      audiences: ['audiences'],
      principalIdClaim: 'principalIdClaim',
    },
    identityTokenOnly: {
      clientIds: ['clientIds'],
      principalIdClaim: 'principalIdClaim',
    },
  },

  // the properties below are optional
  entityIdPrefix: 'entityIdPrefix',
  groupConfiguration: {
    groupClaim: 'groupClaim',
    groupEntityType: 'groupEntityType',
  },
};

Properties

Name	Type	Description
issuer	`string`	The issuer URL of an OIDC identity provider.
tokenSelection	`IResolvable` `\|` `OpenIdConnectTokenSelectionProperty`	The token type that you want to process from your OIDC identity provider.
entityIdPrefix?	`string`	A descriptive string that you want to prefix to user entities from your OIDC identity provider.
groupConfiguration?	`IResolvable` `\|` `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.

issuer

Type: string

The issuer URL of an OIDC identity provider.

This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .

tokenSelection

Type: IResolvable | OpenIdConnectTokenSelectionProperty

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.

entityIdPrefix?

Type: string (optional)

A descriptive string that you want to prefix to user entities from your OIDC identity provider.

For example, if you set an entityIdPrefix of MyOIDCProvider , you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos .

groupConfiguration?

Type: IResolvable | OpenIdConnectGroupConfigurationProperty (optional)

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 .