Skip to content

UpdateIdentitySourceInput

Source code in docs_src/capo_verifiedpermissions/types/update_identity_source_input.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class UpdateIdentitySourceInput(TypedDict, closed=True):
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId"
    """<p>Specifies the ID of the policy store that contains the identity source that you want to update.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>"""
    identity_source_id: (
        "capo_verifiedpermissions.types.identity_source_id.IdentitySourceId"
    )
    """<p>Specifies the ID of the identity source that you want to update.</p>"""
    update_configuration: (
        "capo_verifiedpermissions.types.update_configuration.UpdateConfiguration"
    )
    """<p>Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.</p>"""
    principal_entity_type: NotRequired[
        "capo_verifiedpermissions.types.principal_entity_type.PrincipalEntityType"
    ]
    """<p>Specifies the data type of principals generated for identities authenticated by the identity source.</p>"""

identity_source_id instance-attribute 

identity_source_id: IdentitySourceId

Specifies the ID of the identity source that you want to update.

policy_store_id instance-attribute 

policy_store_id: PolicyStoreId

Specifies the ID of the policy store that contains the identity source that you want to update.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

  • ID: PSEXAMPLEabcdefg111111

  • Alias name: policy-store-alias/example-policy-store

To view aliases, use ListPolicyStoreAliases.

principal_entity_type instance-attribute 

principal_entity_type: NotRequired[PrincipalEntityType]

Specifies the data type of principals generated for identities authenticated by the identity source.

update_configuration instance-attribute 

update_configuration: UpdateConfiguration

Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.