open_id_token_for_developer_identities
Creates, updates, deletes, gets or lists an open_id_token_for_developer_identities resource.
Overview
| Name | open_id_token_for_developer_identities |
| Type | Resource |
| Id | aws.cognito_identity.open_id_token_for_developer_identities |
Fields
The following fields are returned by SELECT queries:
- get_open_id_token_for_developer_identity
| Name | Datatype | Description |
|---|---|---|
identity_id | string | A unique identifier in the format REGION:GUID. (pattern: <code>[\w-]+:[0-9a-f-]+</code>) |
token | string | An OpenID token. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_open_id_token_for_developer_identity | select | region | Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId. You must use Amazon Web Services developer credentials to call this operation. |
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_for_developer_identity
Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId. You must use Amazon Web Services developer credentials to call this operation.
SELECT
identity_id,
token
FROM aws.cognito_identity.open_id_token_for_developer_identities
WHERE region = '{{ region }}' -- required
;