Skip to content

CognitoIdentityProvider

Source code in docs_src/capo_cognito_identity/types/cognito_identity_provider.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class CognitoIdentityProvider(TypedDict, closed=True):
    provider_name: NotRequired[
        "capo_cognito_identity.types.cognito_identity_provider_name.CognitoIdentityProviderName"
    ]
    """<p>The provider name for an Amazon Cognito user pool. For example, <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789</code>.</p>"""
    client_id: NotRequired[
        "capo_cognito_identity.types.cognito_identity_provider_client_id.CognitoIdentityProviderClientId"
    ]
    """<p>The client ID for the Amazon Cognito user pool.</p>"""
    server_side_token_check: NotRequired[
        "capo_cognito_identity.types.cognito_identity_provider_token_check.CognitoIdentityProviderTokenCheck"
    ]
    """<p>TRUE if server-side token validation is enabled for the identity provider’s token.</p> <p>Once you set <code>ServerSideTokenCheck</code> to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or Amazon Web Services credentials for the user.</p> <p>If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.</p>"""

client_id instance-attribute 

client_id: NotRequired[CognitoIdentityProviderClientId]

The client ID for the Amazon Cognito user pool.

provider_name instance-attribute 

provider_name: NotRequired[CognitoIdentityProviderName]

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

server_side_token_check instance-attribute 

server_side_token_check: NotRequired[CognitoIdentityProviderTokenCheck]

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or Amazon Web Services credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.