CognitoIdentityProvider / Client / set_user_pool_client_session_configuration

set_user_pool_client_session_configuration

CognitoIdentityProvider.Client.set_user_pool_client_session_configuration(**kwargs)

Sets the session configuration for a user pool app client. The configurable client-level setting is the maximum validity period for silent reuse of an SSO session. This operation performs a full replacement of the client-level session configuration; every request parameter is required, and session tracking must be enabled for the user pool. The user pool must be in the Essentials or Plus tier. Otherwise, this operation returns a FeatureUnavailableInTierException.

See also: AWS API Documentation

Request Syntax

response = client.set_user_pool_client_session_configuration(
    UserPoolId='string',
    ClientId='string',
    SSOSession={
        'MaxValidityMinutes': 123
    }
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

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

  • ClientId (string) –

    [REQUIRED]

    The ID of the app client that you want to configure.

  • SSOSession (dict) –

    [REQUIRED]

    The SSO session settings for the app client.

    • MaxValidityMinutes (integer) – [REQUIRED]

      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.

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 was applied to.

    • SSOSession (dict) –

      The SSO session settings that were applied to 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