CognitoIdentityProvider / Client / get_tokens_from_refresh_token

get_tokens_from_refresh_token

CognitoIdentityProvider.Client.get_tokens_from_refresh_token(**kwargs)

Given a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token. This operation issues a new refresh token and invalidates the original refresh token after an optional grace period when refresh token rotation is enabled. If refresh token rotation is disabled, issues new ID and access tokens only.

See also: AWS API Documentation

Request Syntax

response = client.get_tokens_from_refresh_token(
    RefreshToken='string',
    ClientId='string',
    ClientSecret='string',
    DeviceKey='string',
    ClientMetadata={
        'string': 'string'
    }
)
Parameters:

  • RefreshToken (string) –

    [REQUIRED]

    A valid refresh token that can authorize the request for new tokens. When refresh token rotation is active in the requested app client, this token is invalidated after the request is complete.

  • ClientId (string) –

    [REQUIRED]

    The app client that issued the refresh token to the user who wants to request new tokens.

  • ClientSecret (string) – The client secret of the requested app client, if the client has a secret.

  • DeviceKey (string) –

    When you enable device remembering, Amazon Cognito issues a device key that you can use for device authentication that bypasses multi-factor authentication (MFA). To implement GetTokensFromRefreshToken in a user pool with device remembering, you must capture the device key from the initial authentication request. If your application doesn’t provide the key of a registered device, Amazon Cognito issues a new one. You must provide the confirmed device key in this request if device remembering is enabled in your user pool.

    For more information about device remembering, see Working with devices.

  • ClientMetadata (dict) –

    A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

    You create custom workflows by assigning Lambda functions to user pool triggers. When you use the GetTokensFromRefreshToken API action, Amazon Cognito invokes the Lambda function the pre token generation trigger.

    For more information, see Using Lambda triggers in the Amazon Cognito Developer Guide.

    Note

    When you use the ClientMetadata parameter, note that Amazon Cognito won’t do the following:

    • Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn’t include triggers, the ClientMetadata parameter serves no purpose.

    • Validate the ClientMetadata value.

    • Encrypt the ClientMetadata value. Don’t send sensitive information in this parameter.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationResult': {
        'AccessToken': 'string',
        'ExpiresIn': 123,
        'TokenType': 'string',
        'RefreshToken': 'string',
        'IdToken': 'string',
        'NewDeviceMetadata': {
            'DeviceKey': 'string',
            'DeviceGroupKey': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • AuthenticationResult (dict) –

      The object that your application receives after authentication. Contains tokens and information for device authentication.

      • AccessToken (string) –

        Your user’s access token.

      • ExpiresIn (integer) –

        The expiration period of the authentication result in seconds.

      • TokenType (string) –

        The intended use of the token, for example Bearer.

      • RefreshToken (string) –

        Your user’s refresh token.

      • IdToken (string) –

        Your user’s ID token.

      • NewDeviceMetadata (dict) –

        The new device metadata from an authentication result.

        • DeviceKey (string) –

          The device key, an identifier used in generating the DEVICE_PASSWORD_VERIFIER for device SRP authentication.

        • DeviceGroupKey (string) –

          The device group key, an identifier used in generating the DEVICE_PASSWORD_VERIFIER for device SRP authentication.

Exceptions