Skip to content

OpenIdConnectConfiguration

Source code in docs_src/capo_verifiedpermissions/types/open_id_connect_configuration.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class OpenIdConnectConfiguration(TypedDict, closed=True):
    issuer: "capo_verifiedpermissions.types.issuer.Issuer"
    """<p>The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path <code>.well-known/openid-configuration</code>.</p>"""
    entity_id_prefix: NotRequired[
        "capo_verifiedpermissions.types.entity_id_prefix.EntityIdPrefix"
    ]
    """<p>A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an <code>entityIdPrefix</code> of <code>MyOIDCProvider</code>, you can reference principals in your policies in the format <code>MyCorp::User::MyOIDCProvider|Carlos</code>.</p>"""
    group_configuration: NotRequired[
        "capo_verifiedpermissions.types.open_id_connect_group_configuration.OpenIdConnectGroupConfiguration"
    ]
    """<p>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 <code>groups</code> claim to <code>MyCorp::UserGroup</code>.</p>"""
    token_selection: "capo_verifiedpermissions.types.open_id_connect_token_selection.OpenIdConnectTokenSelection"
    """<p>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.</p>"""

entity_id_prefix instance-attribute 

entity_id_prefix: NotRequired[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.

group_configuration instance-attribute 

group_configuration: NotRequired[OpenIdConnectGroupConfiguration]

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.

issuer instance-attribute 

issuer: Issuer

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 instance-attribute 

token_selection: OpenIdConnectTokenSelection

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.