CfnIdentitySource

class aws_cdk.aws_verifiedpermissions.CfnIdentitySource(scope, id, *, configuration, policy_store_id, principal_entity_type=None)

Bases: CfnResource

Creates or updates a reference to Amazon Cognito as an external identity provider.

If you are creating a new identity source, then you must specify a Configuration . If you are updating an existing identity source, then you must specify an UpdateConfiguration .

After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine the attributes that are available to access in the Cedar principal from your policies.

Amazon Cognito Identity is not available in all of the same AWS Regions as Amazon Verified Permissions . Because of this, the AWS::VerifiedPermissions::IdentitySource type is not available to create from AWS CloudFormation in Regions where Amazon Cognito Identity is not currently available. Users can still create AWS::VerifiedPermissions::IdentitySource in those Regions, but only from the AWS CLI , Amazon Verified Permissions SDK, or from the AWS console. .. epigraph:

To reference a user from this identity source in your Cedar policies, use the following syntax.

*IdentityType::"|*

Where ``IdentityType`` is the string that you provide to the ``PrincipalEntityType`` parameter for this operation. The ``CognitoUserPoolId`` and ``CognitoClientId`` are defined by the Amazon Cognito user pool.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-identitysource.html
CloudformationResource:: AWS::VerifiedPermissions::IdentitySource
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

cfn_identity_source = verifiedpermissions.CfnIdentitySource(self, "MyCfnIdentitySource",
    configuration=verifiedpermissions.CfnIdentitySource.IdentitySourceConfigurationProperty(
        cognito_user_pool_configuration=verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty(
            user_pool_arn="userPoolArn",

            # the properties below are optional
            client_ids=["clientIds"],
            group_configuration=verifiedpermissions.CfnIdentitySource.CognitoGroupConfigurationProperty(
                group_entity_type="groupEntityType"
            )
        ),
        open_id_connect_configuration=verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty(
            issuer="issuer",
            token_selection=verifiedpermissions.CfnIdentitySource.OpenIdConnectTokenSelectionProperty(
                access_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(
                    audiences=["audiences"],
                    principal_id_claim="principalIdClaim"
                ),
                identity_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(
                    client_ids=["clientIds"],
                    principal_id_claim="principalIdClaim"
                )
            ),

            # the properties below are optional
            entity_id_prefix="entityIdPrefix",
            group_configuration=verifiedpermissions.CfnIdentitySource.OpenIdConnectGroupConfigurationProperty(
                group_claim="groupClaim",
                group_entity_type="groupEntityType"
            )
        )
    ),
    policy_store_id="policyStoreId",

    # the properties below are optional
    principal_entity_type="principalEntityType"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
configuration (Union[IResolvable, IdentitySourceConfigurationProperty, Dict[str, Any]]) – Contains configuration information used when creating a new identity source.
policy_store_id (str) – Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.
principal_entity_type (Optional[str]) – Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::VerifiedPermissions::IdentitySource'

attr_details

Details

Type:: cloudformationAttribute

attr_details_client_ids

Details.ClientIds

Type:: cloudformationAttribute

attr_details_discovery_url

Details.DiscoveryUrl

Type:: cloudformationAttribute

attr_details_open_id_issuer

Details.OpenIdIssuer

Type:: cloudformationAttribute

attr_details_user_pool_arn

Details.UserPoolArn

Type:: cloudformationAttribute

attr_identity_source_id

The unique ID of the new or updated identity store.

CloudformationAttribute:: IdentitySourceId

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

configuration: Contains configuration information used when creating a new identity source.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

policy_store_id: Specifies the ID of the policy store in which you want to store this identity source.

principal_entity_type: Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

CognitoGroupConfigurationProperty

class CfnIdentitySource.CognitoGroupConfigurationProperty(*, group_entity_type)

Bases: object

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

Parameters:: group_entity_type (str) – The name of the schema entity type that’s mapped to the user pool group. Defaults to AWS::CognitoGroup .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitogroupconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

cognito_group_configuration_property = verifiedpermissions.CfnIdentitySource.CognitoGroupConfigurationProperty(
    group_entity_type="groupEntityType"
)

Attributes

group_entity_type

The name of the schema entity type that’s mapped to the user pool group.

Defaults to AWS::CognitoGroup .

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

CognitoUserPoolConfigurationProperty

class CfnIdentitySource.CognitoUserPoolConfigurationProperty(*, user_pool_arn, client_ids=None, group_configuration=None)

Bases: object

A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .

Parameters:

user_pool_arn (str) – The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
client_ids (Optional[Sequence[str]]) – The unique application client IDs that are associated with the specified Amazon Cognito user pool. Example: "ClientIds": ["&ExampleCogClientId;"]
group_configuration (Union[IResolvable, CognitoGroupConfigurationProperty, Dict[str, Any], None]) – The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

cognito_user_pool_configuration_property = verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty(
    user_pool_arn="userPoolArn",

    # the properties below are optional
    client_ids=["clientIds"],
    group_configuration=verifiedpermissions.CfnIdentitySource.CognitoGroupConfigurationProperty(
        group_entity_type="groupEntityType"
    )
)

Attributes

client_ids

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "ClientIds": ["&ExampleCogClientId;"]

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-clientids

group_configuration

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

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

user_pool_arn

//docs.aws.amazon.com//general/latest/gr/aws-arns-and-namespaces.html>`_ of the Amazon Cognito user pool that contains the identities to be authorized.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-cognitouserpoolconfiguration.html#cfn-verifiedpermissions-identitysource-cognitouserpoolconfiguration-userpoolarn
Type:: The `Amazon Resource Name (ARN) <https

IdentitySourceConfigurationProperty

class CfnIdentitySource.IdentitySourceConfigurationProperty(*, cognito_user_pool_configuration=None, open_id_connect_configuration=None)

Bases: object

A structure that contains configuration information used when creating or updating a new identity source.

At this time, the only valid member of this structure is a Amazon Cognito user pool configuration.

You must specify a userPoolArn , and optionally, a ClientId .

Parameters:

cognito_user_pool_configuration (Union[IResolvable, CognitoUserPoolConfigurationProperty, Dict[str, Any], None]) – A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .
open_id_connect_configuration (Union[IResolvable, OpenIdConnectConfigurationProperty, Dict[str, Any], None]) –

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

identity_source_configuration_property = verifiedpermissions.CfnIdentitySource.IdentitySourceConfigurationProperty(
    cognito_user_pool_configuration=verifiedpermissions.CfnIdentitySource.CognitoUserPoolConfigurationProperty(
        user_pool_arn="userPoolArn",

        # the properties below are optional
        client_ids=["clientIds"],
        group_configuration=verifiedpermissions.CfnIdentitySource.CognitoGroupConfigurationProperty(
            group_entity_type="groupEntityType"
        )
    ),
    open_id_connect_configuration=verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty(
        issuer="issuer",
        token_selection=verifiedpermissions.CfnIdentitySource.OpenIdConnectTokenSelectionProperty(
            access_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(
                audiences=["audiences"],
                principal_id_claim="principalIdClaim"
            ),
            identity_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(
                client_ids=["clientIds"],
                principal_id_claim="principalIdClaim"
            )
        ),

        # the properties below are optional
        entity_id_prefix="entityIdPrefix",
        group_configuration=verifiedpermissions.CfnIdentitySource.OpenIdConnectGroupConfigurationProperty(
            group_claim="groupClaim",
            group_entity_type="groupEntityType"
        )
    )
)

Attributes

cognito_user_pool_configuration

A structure that contains configuration information used when creating or updating an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourceconfiguration.html#cfn-verifiedpermissions-identitysource-identitysourceconfiguration-cognitouserpoolconfiguration

open_id_connect_configuration

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

Type:: see

IdentitySourceDetailsProperty

class CfnIdentitySource.IdentitySourceDetailsProperty(*, client_ids=None, discovery_url=None, open_id_issuer=None, user_pool_arn=None)

Bases: object

Parameters:

client_ids (Optional[Sequence[str]]) –
discovery_url (Optional[str]) –
open_id_issuer (Optional[str]) –
user_pool_arn (Optional[str]) –

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

identity_source_details_property = verifiedpermissions.CfnIdentitySource.IdentitySourceDetailsProperty(
    client_ids=["clientIds"],
    discovery_url="discoveryUrl",
    open_id_issuer="openIdIssuer",
    user_pool_arn="userPoolArn"
)

Attributes

client_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourcedetails.html#cfn-verifiedpermissions-identitysource-identitysourcedetails-clientids

Type:: see

discovery_url

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourcedetails.html#cfn-verifiedpermissions-identitysource-identitysourcedetails-discoveryurl

Type:: see

open_id_issuer

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourcedetails.html#cfn-verifiedpermissions-identitysource-identitysourcedetails-openidissuer

Type:: see

user_pool_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-identitysourcedetails.html#cfn-verifiedpermissions-identitysource-identitysourcedetails-userpoolarn

Type:: see

OpenIdConnectAccessTokenConfigurationProperty

class CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(*, audiences=None, principal_id_claim=None)

Bases: object

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims.

Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

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

Parameters:

audiences (Optional[Sequence[str]]) – The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com .
principal_id_claim (Optional[str]) – The claim that determines the principal in OIDC access tokens. For example, sub . Default: - “sub”

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

open_id_connect_access_token_configuration_property = verifiedpermissions.CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(
    audiences=["audiences"],
    principal_id_claim="principalIdClaim"
)

Attributes

audiences

The access token aud claim values that you want to accept in your policy store.

For example, https://myapp.example.com, https://myapp2.example.com .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-audiences

principal_id_claim

The claim that determines the principal in OIDC access tokens.

For example, sub .

Default:

“sub”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-principalidclaim

OpenIdConnectConfigurationProperty

class CfnIdentitySource.OpenIdConnectConfigurationProperty(*, issuer, token_selection, entity_id_prefix=None, group_configuration=None)

Bases: object

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 .

Parameters:

issuer (str) – The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration .
token_selection (Union[IResolvable, OpenIdConnectTokenSelectionProperty, Dict[str, Any]]) – 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.
entity_id_prefix (Optional[str]) – 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 .
group_configuration (Union[IResolvable, OpenIdConnectGroupConfigurationProperty, Dict[str, Any], None]) – 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 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

open_id_connect_configuration_property = verifiedpermissions.CfnIdentitySource.OpenIdConnectConfigurationProperty(
    issuer="issuer",
    token_selection=verifiedpermissions.CfnIdentitySource.OpenIdConnectTokenSelectionProperty(
        access_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(
            audiences=["audiences"],
            principal_id_claim="principalIdClaim"
        ),
        identity_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(
            client_ids=["clientIds"],
            principal_id_claim="principalIdClaim"
        )
    ),

    # the properties below are optional
    entity_id_prefix="entityIdPrefix",
    group_configuration=verifiedpermissions.CfnIdentitySource.OpenIdConnectGroupConfigurationProperty(
        group_claim="groupClaim",
        group_entity_type="groupEntityType"
    )
)

Attributes

entity_id_prefix

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

group_configuration

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 .

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

issuer

The issuer URL of an OIDC identity provider.

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

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

token_selection

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.

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

OpenIdConnectGroupConfigurationProperty

class CfnIdentitySource.OpenIdConnectGroupConfigurationProperty(*, group_claim, group_entity_type)

Bases: object

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 .

Parameters:

group_claim (str) – The token claim that you want Verified Permissions to interpret as group membership. For example, groups .
group_entity_type (str) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

open_id_connect_group_configuration_property = verifiedpermissions.CfnIdentitySource.OpenIdConnectGroupConfigurationProperty(
    group_claim="groupClaim",
    group_entity_type="groupEntityType"
)

Attributes

group_claim

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

For example, groups .

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

group_entity_type

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

OpenIdConnectIdentityTokenConfigurationProperty

class CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(*, client_ids=None, principal_id_claim=None)

Bases: object

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims.

Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

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

Parameters:

client_ids (Optional[Sequence[str]]) – The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213 .
principal_id_claim (Optional[str]) – The claim that determines the principal in OIDC access tokens. For example, sub . Default: - “sub”

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

open_id_connect_identity_token_configuration_property = verifiedpermissions.CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(
    client_ids=["clientIds"],
    principal_id_claim="principalIdClaim"
)

Attributes

client_ids

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.

For example, 1example23456789, 2example10111213 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration-clientids

principal_id_claim

The claim that determines the principal in OIDC access tokens.

For example, sub .

Default:

“sub”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration-principalidclaim

OpenIdConnectTokenSelectionProperty

class CfnIdentitySource.OpenIdConnectTokenSelectionProperty(*, access_token_only=None, identity_token_only=None)

Bases: object

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.

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

Parameters:

access_token_only (Union[IResolvable, OpenIdConnectAccessTokenConfigurationProperty, Dict[str, Any], None]) – The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com , and the claim that you want to map to the principal, for example sub .
identity_token_only (Union[IResolvable, OpenIdConnectIdentityTokenConfigurationProperty, Dict[str, Any], None]) – The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789 , and the claim that you want to map to the principal, for example sub .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

open_id_connect_token_selection_property = verifiedpermissions.CfnIdentitySource.OpenIdConnectTokenSelectionProperty(
    access_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectAccessTokenConfigurationProperty(
        audiences=["audiences"],
        principal_id_claim="principalIdClaim"
    ),
    identity_token_only=verifiedpermissions.CfnIdentitySource.OpenIdConnectIdentityTokenConfigurationProperty(
        client_ids=["clientIds"],
        principal_id_claim="principalIdClaim"
    )
)

Attributes

access_token_only

The OIDC configuration for processing access tokens.

Contains allowed audience claims, for example https://auth.example.com , and the claim that you want to map to the principal, for example sub .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html#cfn-verifiedpermissions-identitysource-openidconnecttokenselection-accesstokenonly

identity_token_only

The OIDC configuration for processing identity (ID) tokens.

Contains allowed client ID claims, for example 1example23456789 , and the claim that you want to map to the principal, for example sub .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnecttokenselection.html#cfn-verifiedpermissions-identitysource-openidconnecttokenselection-identitytokenonly