Amazon Cognito Identity

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for SupportedLoginProviders are as follows:

Facebook: graph.facebook.com
Google: accounts.google.com
Amazon: www.amazon.com
Twitter: api.twitter.com
Digits: www.digits.com

You must use AWS Developer credentials to call this API.

X-Amz-Target'AWSCognitoIdentityService.CreateIdentityPool' required

Request body

IdentityPoolNamestring required

A string that you provide.

AllowUnauthenticatedIdentitiesboolean required

TRUE if the identity pool supports unauthenticated logins.

AllowClassicFlowboolean

Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the Amazon Cognito Developer Guide.

SupportedLoginProvidersobject

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

DeveloperProviderNamestring

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>). Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

OpenIdConnectProviderARNsARNString[]

The Amazon Resource Names (ARN) of the OpenID Connect providers.

SamlProviderARNsARNString[]

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

IdentityPoolTagsobject

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

Response

Success

IdentityPoolIdstring required

An identity pool ID in the format REGION:GUID.