Package software.amazon.awscdk.services.verifiedpermissions

Interface CfnIdentitySource.OpenIdConnectConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIdentitySource.OpenIdConnectConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIdentitySource

@Stability(Stable)
public static interface CfnIdentitySource.OpenIdConnectConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.verifiedpermissions.*;
 OpenIdConnectConfigurationProperty openIdConnectConfigurationProperty = OpenIdConnectConfigurationProperty.builder()
         .issuer("issuer")
         .tokenSelection(OpenIdConnectTokenSelectionProperty.builder()
                 .accessTokenOnly(OpenIdConnectAccessTokenConfigurationProperty.builder()
                         .audiences(List.of("audiences"))
                         .principalIdClaim("principalIdClaim")
                         .build())
                 .identityTokenOnly(OpenIdConnectIdentityTokenConfigurationProperty.builder()
                         .clientIds(List.of("clientIds"))
                         .principalIdClaim("principalIdClaim")
                         .build())
                 .build())
         // the properties below are optional
         .entityIdPrefix("entityIdPrefix")
         .groupConfiguration(OpenIdConnectGroupConfigurationProperty.builder()
                 .groupClaim("groupClaim")
                 .groupEntityType("groupEntityType")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIdentitySource.OpenIdConnectConfigurationProperty.Builder	A builder for CfnIdentitySource.OpenIdConnectConfigurationProperty
static final class	CfnIdentitySource.OpenIdConnectConfigurationProperty.Jsii$Proxy	An implementation for CfnIdentitySource.OpenIdConnectConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIdentitySource.OpenIdConnectConfigurationProperty.Builder	builder()
default String	getEntityIdPrefix()	A descriptive string that you want to prefix to user entities from your OIDC identity provider.
default Object	getGroupConfiguration()	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.
String	getIssuer()	The issuer URL of an OIDC identity provider.
Object	getTokenSelection()	The token type that you want to process from your OIDC identity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIssuer

@Stability(Stable)
@NotNull
String getIssuer()

The issuer URL of an OIDC identity provider.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-issuer

getTokenSelection

@Stability(Stable)
@NotNull
Object getTokenSelection()

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.

Returns union: either IResolvable or CfnIdentitySource.OpenIdConnectTokenSelectionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-tokenselection

getEntityIdPrefix

@Stability(Stable)
@Nullable
default String getEntityIdPrefix()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-entityidprefix

getGroupConfiguration

@Stability(Stable)
@Nullable
default Object getGroupConfiguration()

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 .

Returns union: either IResolvable or CfnIdentitySource.OpenIdConnectGroupConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectconfiguration-groupconfiguration

builder

@Stability(Stable)
static CfnIdentitySource.OpenIdConnectConfigurationProperty.Builder builder()

Returns:

a CfnIdentitySource.OpenIdConnectConfigurationProperty.Builder of CfnIdentitySource.OpenIdConnectConfigurationProperty