Icon

AWS Cognito Identity Pools (Federated Identities) (version v1.*.*)

create_identity_pool

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per 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.

Parameters

$body

Input to the CreateIdentityPool action.

Type: object

{
"CognitoIdentityProviders" : [ {
"ServerSideTokenCheck" : "TRUE if server-side token validation is enabled for the identity provider’s token. \nOnce you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. \nIf the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.",
"ProviderName" : "The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.",
"ClientId" : "The client ID for the Amazon Cognito user pool."
} ],
"DeveloperProviderName" : "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 DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-). \nOnce you have set a developer provider name, you cannot change it. Please take care in setting this parameter.",
"IdentityPoolName" : "A string that you provide.",
"AllowUnauthenticatedIdentities" : "TRUE if the identity pool supports unauthenticated logins.",
"SupportedLoginProviders" : "Optional key:value pairs mapping provider names to provider app IDs.",
"OpenIdConnectProviderARNs" : [ "string" ],
"SamlProviderARNs" : [ "string" ],
"IdentityPoolTags" : "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."
}

delete_identities

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the DeleteIdentities action.

Type: object

{
"IdentityIdsToDelete" : [ "string" ]
}

delete_identity_pool

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the DeleteIdentityPool action.

Type: object

{
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

describe_identity

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the DescribeIdentity action.

Type: object

{
"IdentityId" : "A unique identifier in the format REGION:GUID."
}

describe_identity_pool

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the DescribeIdentityPool action.

Type: object

{
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

get_credentials_for_identity

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.

Parameters

$body

Input to the GetCredentialsForIdentity action.

Type: object

{
"CustomRoleArn" : "The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.",
"Logins" : "A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax \"provider_name\": \"provider_user_identifier\". \nLogins should not be specified when trying to get credentials for an unauthenticated identity. \nThe Logins parameter is required when using identities associated with external identity providers such as FaceBook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.",
"IdentityId" : "A unique identifier in the format REGION:GUID."
}

get_id

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.

Parameters

$body

Input to the GetId action.

Type: object

{
"AccountId" : "A standard AWS account ID (9+ digits).",
"Logins" : "A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows: \n Facebook: graph.facebook.com \n 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. \n Google: accounts.google.com \n Amazon: www.amazon.com \n Twitter: api.twitter.com \n Digits: www.digits.com ",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

get_identity_pool_roles

Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the GetIdentityPoolRoles action.

Type: object

{
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

get_open_id_token

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenId token is valid for 10 minutes.
This is a public API. You do not need any credentials to call this API.

Parameters

$body

Input to the GetOpenIdToken action.

Type: object

{
"Logins" : "A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenId Connect provider, always include the id_token.",
"IdentityId" : "A unique identifier in the format REGION:GUID."
}

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 AWS Developer credentials to call this API.

Parameters

$body

Input to the GetOpenIdTokenForDeveloperIdentity action.

Type: object

{
"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.",
"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 AWS 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 AWS resources for the token's duration.",
"IdentityId" : "A unique identifier in the format REGION:GUID.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

list_identities

Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the ListIdentities action.

Type: object

{
"NextToken" : "A pagination token.",
"MaxResults" : "The maximum number of identities to return.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID.",
"HideDisabled" : "An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response."
}

list_identity_pools

Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.

This operation has no parameters

list_tags_for_resource

Lists the tags that are assigned to an Amazon Cognito 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.
You can use this action up to 10 times per second, per account.

Parameters

$body

Type: object

{
"ResourceArn" : "The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to."
}

lookup_developer_identity

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.
LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the LookupDeveloperIdentityInput action.

Type: object

{
"NextToken" : "A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.",
"MaxResults" : "The maximum number of identities to return.",
"IdentityId" : "A unique identifier in the format REGION:GUID.",
"DeveloperUserIdentifier" : "A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

merge_developer_identities

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.
The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the MergeDeveloperIdentities action.

Type: object

{
"SourceUserIdentifier" : "User identifier for the source user. The value should be a DeveloperUserIdentifier.",
"DeveloperProviderName" : "The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID.",
"DestinationUserIdentifier" : "User identifier for the destination user. The value should be a DeveloperUserIdentifier."
}

set_identity_pool_roles

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the SetIdentityPoolRoles action.

Type: object

{
"RoleMappings" : "How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\". \nUp to 25 rules can be specified per identity provider.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID.",
"Roles" : "The map of roles associated with this pool. For a given role, the key will be either \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN."
}

tag_resource

Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.
Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.
Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.
You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

Parameters

$body

Type: object

{
"ResourceArn" : "The Amazon Resource Name (ARN) of the identity pool to assign the tags to.",
"Tags" : "The tags to assign to the identity pool."
}

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.
You must use AWS Developer credentials to call this API.

Parameters

$body

Input to the UnlinkDeveloperIdentity action.

Type: object

{
"DeveloperProviderName" : "The \"domain\" by which Cognito will refer to your users.",
"IdentityId" : "A unique identifier in the format REGION:GUID.",
"DeveloperUserIdentifier" : "A unique ID used by your backend authentication process to identify a user.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID."
}

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.

Parameters

$body

Input to the UnlinkIdentity action.

Type: object

{
"Logins" : "A set of optional name-value pairs that map provider names to provider tokens.",
"IdentityId" : "A unique identifier in the format REGION:GUID.",
"LoginsToRemove" : [ "string" ]
}

untag_resource

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

Parameters

$body

Type: object

{
"ResourceArn" : "The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.",
"TagKeys" : [ "string" ]
}

update_identity_pool

Updates an identity pool.
You must use AWS Developer credentials to call this API.

Parameters

$body

An object representing an Amazon Cognito identity pool.

Type: object

{
"CognitoIdentityProviders" : [ {
"ServerSideTokenCheck" : "TRUE if server-side token validation is enabled for the identity provider’s token. \nOnce you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user. \nIf the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.",
"ProviderName" : "The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.",
"ClientId" : "The client ID for the Amazon Cognito user pool."
} ],
"DeveloperProviderName" : "The \"domain\" by which Cognito will refer to your users.",
"IdentityPoolId" : "An identity pool ID in the format REGION:GUID.",
"IdentityPoolName" : "A string that you provide.",
"AllowUnauthenticatedIdentities" : "TRUE if the identity pool supports unauthenticated logins.",
"SupportedLoginProviders" : "Optional key:value pairs mapping provider names to provider app IDs.",
"OpenIdConnectProviderARNs" : [ "string" ],
"SamlProviderARNs" : [ "string" ],
"IdentityPoolTags" : "The tags that are assigned 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."
}