open_id_tokens
Creates, updates, deletes, gets or lists an open_id_tokens resource.
Overview
| Name | open_id_tokens |
| Type | Resource |
| Id | aws.cognito_identity.open_id_tokens |
Fields
The following fields are returned by SELECT queries:
- get_open_id_token
| Name | Datatype | Description |
|---|---|---|
identity_id | string | A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
token | string | An OpenID token, valid for 10 minutes. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_open_id_token | select | region | Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenID token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API. |
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_open_id_token
Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link. The OpenID token is valid for 10 minutes. This is a public API. You do not need any credentials to call this API.
SELECT
identity_id,
token
FROM aws.cognito_identity.open_id_tokens
WHERE region = '{{ region }}' -- required
;