GetOpenIdTokenForDeveloperIdentity
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 developer credentials to call this operation.
Request Syntax
{
"IdentityId": "string
",
"IdentityPoolId": "string
",
"Logins": {
"string
" : "string
"
},
"PrincipalTags": {
"string
" : "string
"
},
"TokenDuration": number
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- IdentityId
-
A unique identifier in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
Required: No
- IdentityPoolId
-
An identity pool ID in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
Required: Yes
- Logins
-
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax
"developer_provider_name": "developer_user_identifier"
. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 50000.
Required: Yes
- PrincipalTags
-
Use this operation to configure attribute mappings for custom providers.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- TokenDuration
-
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary Amazon credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your Amazon resources for the token's duration.
Note
Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
Type: Long
Valid Range: Minimum value of 1. Maximum value of 86400.
Required: No
Response Syntax
{
"IdentityId": "string",
"Token": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- IdentityId
-
A unique identifier in the format REGION:GUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+:[0-9a-f-]+
- Token
-
An OpenID token.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- DeveloperUserAlreadyRegisteredException
-
The provided developer user identifier is already registered with Cognito under a different identity ID.
HTTP Status Code: 400
- InternalErrorException
-
Thrown when the service encounters an error during processing the request.
HTTP Status Code: 500
- InvalidParameterException
-
Thrown for missing or bad input parameter(s).
HTTP Status Code: 400
- NotAuthorizedException
-
Thrown when a user is not authorized to access the requested resource.
HTTP Status Code: 400
- ResourceConflictException
-
Thrown when a user tries to use a login which is already linked to another account.
HTTP Status Code: 400
- ResourceNotFoundException
-
Thrown when the requested resource (for example, a dataset or record) does not exist.
HTTP Status Code: 400
- TooManyRequestsException
-
Thrown when a request is throttled.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: