aws_cognito_identity
Amazon Cognito Federated Identities
Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments.
It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.
Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.
For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.
For more information see Amazon Cognito Federated Identities.Summary
Functions
-
create_identity_pool(Client, Input)
Creates a new identity pool.
- create_identity_pool(Client, Input, Options)
-
delete_identities(Client, Input)
Deletes identities from an identity pool.
- delete_identities(Client, Input, Options)
-
delete_identity_pool(Client, Input)
Deletes an identity pool.
- delete_identity_pool(Client, Input, Options)
-
describe_identity(Client, Input)
Returns metadata related to the given identity, including when the identity was created and any associated linked logins.
- describe_identity(Client, Input, Options)
-
describe_identity_pool(Client, Input)
Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.
- describe_identity_pool(Client, Input, Options)
-
get_credentials_for_identity(Client, Input)
Returns credentials for the provided identity ID.
- get_credentials_for_identity(Client, Input, Options)
-
get_id(Client, Input)
Generates (or retrieves) a Cognito ID.
- get_id(Client, Input, Options)
-
get_identity_pool_roles(Client, Input)
Gets the roles for an identity pool.
- get_identity_pool_roles(Client, Input, Options)
-
get_open_id_token(Client, Input)
Gets an OpenID token, using a known Cognito ID.
- get_open_id_token(Client, Input, Options)
-
get_open_id_token_for_developer_identity(Client, Input)
Registers (or retrieves) a Cognito
IdentityId
and an OpenID Connect token for a user authenticated by your backend authentication process. - get_open_id_token_for_developer_identity(Client, Input, Options)
-
get_principal_tag_attribute_map(Client, Input)
Use
GetPrincipalTagAttributeMap
to list all mappings betweenPrincipalTags
and user attributes. - get_principal_tag_attribute_map(Client, Input, Options)
-
list_identities(Client, Input)
Lists the identities in an identity pool.
- list_identities(Client, Input, Options)
-
list_identity_pools(Client, Input)
Lists all of the Cognito identity pools registered for your account.
- list_identity_pools(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
Lists the tags that are assigned to an Amazon Cognito identity pool.
- list_tags_for_resource(Client, Input, Options)
-
lookup_developer_identity(Client, Input)
Retrieves the
IdentityID
associated with aDeveloperUserIdentifier
or the list ofDeveloperUserIdentifier
values associated with anIdentityId
for an existing identity. - lookup_developer_identity(Client, Input, Options)
-
merge_developer_identities(Client, Input)
Merges two users having different
IdentityId
s, existing in the same identity pool, and identified by the same developer provider. - merge_developer_identities(Client, Input, Options)
-
set_identity_pool_roles(Client, Input)
Sets the roles for an identity pool.
- set_identity_pool_roles(Client, Input, Options)
-
set_principal_tag_attribute_map(Client, Input)
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
- set_principal_tag_attribute_map(Client, Input, Options)
-
tag_resource(Client, Input)
Assigns a set of tags to the specified Amazon Cognito identity pool.
- tag_resource(Client, Input, Options)
-
unlink_developer_identity(Client, Input)
Unlinks a
DeveloperUserIdentifier
from an existing identity. - unlink_developer_identity(Client, Input, Options)
-
unlink_identity(Client, Input)
Unlinks a federated identity from an existing account.
- unlink_identity(Client, Input, Options)
-
untag_resource(Client, Input)
Removes the specified tags from the specified Amazon Cognito identity pool.
- untag_resource(Client, Input, Options)
-
update_identity_pool(Client, Input)
Updates an identity pool.
- update_identity_pool(Client, Input, Options)
Functions
create_identity_pool(Client, Input)
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
create_identity_pool(Client, Input, Options)
delete_identities(Client, Input)
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.delete_identities(Client, Input, Options)
delete_identity_pool(Client, Input)
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.delete_identity_pool(Client, Input, Options)
describe_identity(Client, Input)
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.describe_identity(Client, Input, Options)
describe_identity_pool(Client, Input)
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.describe_identity_pool(Client, Input, Options)
get_credentials_for_identity(Client, Input)
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.get_credentials_for_identity(Client, Input, Options)
get_id(Client, Input)
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.get_id(Client, Input, Options)
get_identity_pool_roles(Client, Input)
Gets the roles for an identity pool.
You must use AWS Developer credentials to call this API.get_identity_pool_roles(Client, Input, Options)
get_open_id_token(Client, Input)
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.get_open_id_token(Client, Input, Options)
get_open_id_token_for_developer_identity(Client, Input)
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
.
get_open_id_token_for_developer_identity(Client, Input, Options)
get_principal_tag_attribute_map(Client, Input)
Use GetPrincipalTagAttributeMap
to list all mappings between
PrincipalTags
and user attributes.
get_principal_tag_attribute_map(Client, Input, Options)
list_identities(Client, Input)
Lists the identities in an identity pool.
You must use AWS Developer credentials to call this API.list_identities(Client, Input, Options)
list_identity_pools(Client, Input)
Lists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.list_identity_pools(Client, Input, Options)
list_tags_for_resource(Client, Input)
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.list_tags_for_resource(Client, Input, Options)
lookup_developer_identity(Client, Input)
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.
lookup_developer_identity(Client, Input, Options)
merge_developer_identities(Client, Input)
Merges two users having different IdentityId
s, 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.
merge_developer_identities(Client, Input, Options)
set_identity_pool_roles(Client, Input)
Sets the roles for an identity pool.
These roles are used when making calls to GetCredentialsForIdentity
action.
set_identity_pool_roles(Client, Input, Options)
set_principal_tag_attribute_map(Client, Input)
You can use this operation to use default (username and clientID) attribute or custom attribute mappings.
set_principal_tag_attribute_map(Client, Input, Options)
tag_resource(Client, Input)
Assigns a set of tags to the specified 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.tag_resource(Client, Input, Options)
unlink_developer_identity(Client, Input)
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.unlink_developer_identity(Client, Input, Options)
unlink_identity(Client, Input)
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.unlink_identity(Client, Input, Options)
untag_resource(Client, Input)
Removes the specified tags from the specified Amazon Cognito identity pool.
You can use this action up to 5 times per second, per accountuntag_resource(Client, Input, Options)
update_identity_pool(Client, Input)
Updates an identity pool.
You must use AWS Developer credentials to call this API.