Menu
Amazon Cognito Federated Identities
API Reference (API Version 2014-06-30)

UpdateIdentityPool

Updates an identity pool.

You must use AWS Developer credentials to call this API.

Request Syntax

{
   "AllowUnauthenticatedIdentities": boolean,
   "CognitoIdentityProviders": [ 
      { 
         "ClientId": "string",
         "ProviderName": "string",
         "ServerSideTokenCheck": boolean
      }
   ],
   "DeveloperProviderName": "string",
   "IdentityPoolId": "string",
   "IdentityPoolName": "string",
   "OpenIdConnectProviderARNs": [ "string" ],
   "SamlProviderARNs": [ "string" ],
   "SupportedLoginProviders": { 
      "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.

AllowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

Type: Boolean

Required: Yes

CognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

Type: Array of CognitoIdentityProvider objects

Required: No

DeveloperProviderName

The "domain" by which Cognito will refer to your users.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w._-]+

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

IdentityPoolName

A string that you provide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w ]+

Required: Yes

OpenIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

SamlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

SupportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Type: String to string map

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w.;_/-]+

Required: No

Response Syntax

{
   "AllowUnauthenticatedIdentities": boolean,
   "CognitoIdentityProviders": [ 
      { 
         "ClientId": "string",
         "ProviderName": "string",
         "ServerSideTokenCheck": boolean
      }
   ],
   "DeveloperProviderName": "string",
   "IdentityPoolId": "string",
   "IdentityPoolName": "string",
   "OpenIdConnectProviderARNs": [ "string" ],
   "SamlProviderARNs": [ "string" ],
   "SupportedLoginProviders": { 
      "string" : "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.

AllowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

Type: Boolean

CognitoIdentityProviders

A list representing an Amazon Cognito user pool and its client ID.

Type: Array of CognitoIdentityProvider objects

DeveloperProviderName

The "domain" by which Cognito will refer to your users.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w._-]+

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-]+

IdentityPoolName

A string that you provide.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w ]+

OpenIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

SamlProviderARNs

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

SupportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Type: String to string map

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w.;_/-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

Thrown if there are parallel requests to modify a resource.

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

Example

UpdateIdentityPool

The following examples show a request and response for the UpdateIdentityPool action. The request and response bodies have been formatted for readability and may not match the content-length value. Note: For the key "api.twitter.com" and "www.digits.com" the value to be set in the dictionary is a concatenation of the consumer key and consumer secret strings separated by a semicolon.

Sample Request


POST / HTTP/1.1
CONTENT-TYPE: application/json
CONTENT-LENGTH: 423
X-AMZ-TARGET: com.amazonaws.cognito.identity.model.AWSCognitoIdentityService.UpdateIdentityPool
HOST: <endpoint>
X-AMZ-DATE: 20140804T232959Z
AUTHORIZATION: AWS4-HMAC-SHA256 Credential=<credential>, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=<signature>

{
    "IdentityPoolId": "us-east-1:c1731993-c776-4ae2-86c6-554aeEXAMPLE",
    "IdentityPoolName": "MyIdentityPool",
    "AllowUnauthenticatedIdentities": true,
    "SupportedLoginProviders":
    {
        "www.amazon.com": "amzn1.application-oa2-client.188a56d827a7d6555a8b67a5d",
        "graph.facebook.com": "7346241598935555",
        "accounts.google.com": "123456789012.apps.googleusercontent.com",
        "api.twitter.com": "xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw",
        "www.digits.com": "xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw"
    }
}
               

Sample Response


1.1 200 OK
x-amzn-requestid: a1174234-ef05-4c60-bfcb-04176a6ba6a3
date: Mon, 04 Aug 2014 23:30:00 GMT
content-type: application/json
content-length: 356

{
    "AllowUnauthenticatedIdentities": true,
    "IdentityPoolId": "us-east-1:c1731993-c776-4ae2-86c6-554aeEXAMPLE",
    "IdentityPoolName": "MyIdentityPool",
    "SupportedLoginProviders":
    {
        "www.amazon.com": "amzn1.application-oa2-client.188a56d827a7d6555a8b67a5d",
        "graph.facebook.com": "7346241598935555",
        "accounts.google.com": "123456789012.apps.googleusercontent.com",
        "api.twitter.com": "xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw",
        "www.digits.com": "xvz1evFS4wEEPTGEFPHBog;kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw"
    }
}
               

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: