tokens_from_refresh_tokens

Creates, updates, deletes, gets or lists a tokens_from_refresh_tokens resource.

Overview

Name	tokens_from_refresh_tokens
Type	Resource
Id	aws.cognito_idp.tokens_from_refresh_tokens

Fields

The following fields are returned by SELECT queries:

get_tokens_from_refresh_token

Name	Datatype	Description
access_token	string	Your user's access token. (pattern: <code>[A-Za-z0-9-_=.]+</code>)
expires_in	integer	The expiration period of the authentication result in seconds.
id_token	string	Your user's ID token. (pattern: <code>[A-Za-z0-9-_=.]+</code>)
new_device_metadata	object	The new device metadata from an authentication result.
refresh_token	string	Your user's refresh token. (pattern: <code>[A-Za-z0-9-_=.]+</code>)
token_type	string	The intended use of the token, for example Bearer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tokens_from_refresh_token	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_tokens_from_refresh_token

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.

SELECT
access_token,
expires_in,
id_token,
new_device_metadata,
refresh_token,
token_type
FROM aws.cognito_idp.tokens_from_refresh_tokens
WHERE region = '{{ region }}' -- required
;