AWS::VerifiedPermissions::IdentitySource OpenIdConnectConfiguration

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "EntityIdPrefix" : String,
  "GroupConfiguration" : OpenIdConnectGroupConfiguration,
  "Issuer" : String,
  "TokenSelection" : OpenIdConnectTokenSelection
}

YAML

  EntityIdPrefix: String
  GroupConfiguration: 
    OpenIdConnectGroupConfiguration
  Issuer: String
  TokenSelection: 
    OpenIdConnectTokenSelection

Properties

EntityIdPrefix

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.

Required: No

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

GroupConfiguration

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.

Required: No

Type: OpenIdConnectGroupConfiguration

Update requires: No interruption

Issuer

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

Required: Yes

Type: String

Pattern: ^https://.*$

Minimum: 1

Maximum: 2048

Update requires: No interruption

TokenSelection

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.

Required: Yes

Type: OpenIdConnectTokenSelection

Update requires: No interruption