Skip to content

AuthenticationResultType

Source code in docs_src/capo_cognito_identity_provider/types/authentication_result_type.py
class AuthenticationResultType(TypedDict, closed=True):
    access_token: NotRequired[
        "capo_cognito_identity_provider.types.token_model_type.TokenModelType"
    ]
    """<p>Your user's access token.</p>"""
    expires_in: "capo_cognito_identity_provider.types.integer_type.IntegerType"
    """<p>The expiration period of the authentication result in seconds.</p>"""
    token_type: NotRequired[
        "capo_cognito_identity_provider.types.string_type.StringType"
    ]
    """<p>The intended use of the token, for example <code>Bearer</code>.</p>"""
    refresh_token: NotRequired[
        "capo_cognito_identity_provider.types.token_model_type.TokenModelType"
    ]
    """<p>Your user's refresh token.</p>"""
    id_token: NotRequired[
        "capo_cognito_identity_provider.types.token_model_type.TokenModelType"
    ]
    """<p>Your user's ID token.</p>"""
    new_device_metadata: NotRequired[
        "capo_cognito_identity_provider.types.new_device_metadata_type.NewDeviceMetadataType"
    ]
    """<p>The new device metadata from an authentication result.</p>"""

access_token instance-attribute

access_token: NotRequired[TokenModelType]

Your user's access token.

expires_in instance-attribute

expires_in: IntegerType

The expiration period of the authentication result in seconds.

id_token instance-attribute

id_token: NotRequired[TokenModelType]

Your user's ID token.

new_device_metadata instance-attribute

new_device_metadata: NotRequired[NewDeviceMetadataType]

The new device metadata from an authentication result.

refresh_token instance-attribute

refresh_token: NotRequired[TokenModelType]

Your user's refresh token.

token_type instance-attribute

token_type: NotRequired[StringType]

The intended use of the token, for example Bearer.