GetId
Generates (or retrieves) IdentityID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
Request Syntax
{
"AccountId": "string",
"IdentityPoolId": "string",
"Logins": {
"string" : "string"
}
}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.
- AccountId
-
A standard AWS account ID (9+ digits).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 15.
Pattern:
\d+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. The available provider names for
Loginsare as follows:-
Facebook:
graph.facebook.com -
Amazon Cognito user pool:
cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example,cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789. -
Google:
accounts.google.com -
Amazon:
www.amazon.com -
Twitter:
api.twitter.com -
Digits:
www.digits.com
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: No
-
Response Syntax
{
"IdentityId": "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-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- ExternalServiceException
-
An exception thrown when a dependent service such as Facebook or Twitter is not responding
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
- LimitExceededException
-
Thrown when the total number of user pools has exceeded a preset limit.
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
Examples
GetId
The following example shows a GetId request for an
unauthenticated identity. The request body has been edited for readability and may
not match the stated content-length.
Sample Request
POST / HTTP/1.1
CONTENT-TYPE: application/x-amz-json-1.1
CONTENT-LENGTH: 252
X-AMZ-TARGET: com.amazonaws.cognito.identity.model.AWSCognitoIdentityService.GetId
HOST: <endpoint>
X-AMZ-DATE: 20140730T232759Z
{
"AccountId": "123456789012",
"IdentityPoolId": "us-east-1:177a950c-2c08-43f0-9983-28727EXAMPLE"
}
Sample Response
1.1 200 OK
x-amzn-requestid: ff1ca798-b930-4b81-9ef3-c02e770188af
date: Mon, 04 Aug 2014 22:03:36 GMT
CONTENT-TYPE: application/x-amz-json-1.1
content-length: 152
{
"IdentityId": "us-east-1:88859bc9-0149-4183-bf10-39e36EXAMPLE"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
