CognitoIdentityProvider / Client / get_user_pool_client_session_configuration

get_user_pool_client_session_configuration

CognitoIdentityProvider.Client.get_user_pool_client_session_configuration(**kwargs)

Retrieves the session configuration for a user pool app client. If you have never called SetUserPoolClientSessionConfiguration for the app client, this operation returns the default SSO session maximum validity of 60 minutes.

See also: AWS API Documentation

Request Syntax

response = client.get_user_pool_client_session_configuration(
    UserPoolId='string',
    ClientId='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool that contains the app client.

  • ClientId (string) –

    [REQUIRED]

    The ID of the app client where you want to retrieve the session configuration.

Return type:

dict

Returns:

Response Syntax

{
    'UserPoolId': 'string',
    'ClientId': 'string',
    'SSOSession': {
        'MaxValidityMinutes': 123
    }
}

Response Structure

  • (dict) –

    • UserPoolId (string) –

      The ID of the user pool that contains the app client.

    • ClientId (string) –

      The ID of the app client that the session configuration applies to.

    • SSOSession (dict) –

      The SSO session settings for the app client.

      • MaxValidityMinutes (integer) –

        The maximum amount of time, in minutes, that this app client silently reuses an existing SSO session, returning a new set of tokens without requiring the user to re-authenticate, measured from the user’s last fresh authentication. The minimum value is 0 and the maximum value is 129600 (90 days). The default is 60. A value of 0 means that this app client never silently reuses the SSO session and always re-authenticates the user. The SSO session record and its cookie are still created regardless of this value, and other app clients in the same user pool can still reuse the session.

Exceptions