Get Tokens From Refresh Token

cognitoidentityprovider_get_tokens_from_refresh_token

R Documentation

Given a refresh token, issues new ID, access, and optionally refresh tokens for the user who owns the submitted token¶

Description¶

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.

Usage¶

cognitoidentityprovider_get_tokens_from_refresh_token(RefreshToken,
  ClientId, ClientSecret, DeviceKey, ClientMetadata)

Arguments¶

RefreshToken

[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 and after an optional grace period.

ClientId

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

ClientSecret

The client secret of the requested app client, if the client has a secret.

DeviceKey

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 get_tokens_from_refresh_token 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

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers.

When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.

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.

Value¶

A list with the following syntax:

list(
  AuthenticationResult = list(
    AccessToken = "string",
    ExpiresIn = 123,
    TokenType = "string",
    RefreshToken = "string",
    IdToken = "string",
    NewDeviceMetadata = list(
      DeviceKey = "string",
      DeviceGroupKey = "string"
    )
  )
)

Request syntax¶

svc$get_tokens_from_refresh_token(
  RefreshToken = "string",
  ClientId = "string",
  ClientSecret = "string",
  DeviceKey = "string",
  ClientMetadata = list(
    "string"
  )
)