amazonaws.com – 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 .
For more information see .
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:cognito-identity/2014-06-30.json
- Provider
- amazonaws.com:cognito-identity / cognito-identity
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/cognito-identity/2014-06-30/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/cognito-identity/2014-06-30/openapi.yaml
Tools (25)
Extracted live via the executor SDK.
-
xAmzTargetAwsCognitoIdentityServiceCreateIdentityPool.createIdentityPoolCreates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The keys for
SupportedLoginProvidersare 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.
-
-
xAmzTargetAwsCognitoIdentityServiceDeleteIdentities.deleteIdentitiesDeletes 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.
-
xAmzTargetAwsCognitoIdentityServiceDeleteIdentityPool.deleteIdentityPoolDeletes 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.
-
xAmzTargetAwsCognitoIdentityServiceDescribeIdentity.describeIdentityReturns 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.
-
xAmzTargetAwsCognitoIdentityServiceDescribeIdentityPool.describeIdentityPoolGets 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.
-
xAmzTargetAwsCognitoIdentityServiceGetCredentialsForIdentity.getCredentialsForIdentityReturns 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.
-
xAmzTargetAwsCognitoIdentityServiceGetId.getIdGenerates (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.
-
xAmzTargetAwsCognitoIdentityServiceGetIdentityPoolRoles.getIdentityPoolRolesGets the roles for an identity pool.
You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceGetOpenIdToken.getOpenIdTokenGets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId [blocked]. 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.
-
xAmzTargetAwsCognitoIdentityServiceGetOpenIdTokenForDeveloperIdentity.getOpenIdTokenForDeveloperIdentityRegisters (or retrieves) a Cognito
IdentityIdand 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 theLoginsmap, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.You can use
GetOpenIdTokenForDeveloperIdentityto 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, theIdentityIdshould be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existingIdentityId. This API will create the identity in the specifiedIdentityPoolId.You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceGetPrincipalTagAttributeMap.getPrincipalTagAttributeMapUse
GetPrincipalTagAttributeMapto list all mappings betweenPrincipalTagsand user attributes. -
xAmzTargetAwsCognitoIdentityServiceListIdentities.listIdentitiesLists the identities in an identity pool.
You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceListIdentityPools.listIdentityPoolsLists all of the Cognito identity pools registered for your account.
You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceListTagsForResource.listTagsForResourceLists 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.
-
xAmzTargetAwsCognitoIdentityServiceLookupDeveloperIdentity.lookupDeveloperIdentityRetrieves the
IdentityIDassociated with aDeveloperUserIdentifieror the list ofDeveloperUserIdentifiervalues associated with anIdentityIdfor an existing identity. EitherIdentityIDorDeveloperUserIdentifiermust 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,DeveloperUserIdentifierwill be matched againstIdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise aResourceConflictExceptionis thrown.LookupDeveloperIdentityis 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 [blocked] is a better option for higher-volume operations for user authentication.You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceMergeDeveloperIdentities.mergeDeveloperIdentitiesMerges 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 theIdentityIdof theDestinationUserIdentifier. 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.
-
xAmzTargetAwsCognitoIdentityServiceSetIdentityPoolRoles.setIdentityPoolRolesSets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity [blocked] action.
You must use AWS Developer credentials to call this API.
-
xAmzTargetAwsCognitoIdentityServiceSetPrincipalTagAttributeMap.setPrincipalTagAttributeMapYou can use this operation to use default (username and clientID) attribute or custom attribute mappings.
-
xAmzTargetAwsCognitoIdentityServiceTagResource.tagResourceAssigns 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
Environmenttag key to both identity pools. The value of this key might beTestfor one identity pool andProductionfor 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.
-
xAmzTargetAwsCognitoIdentityServiceUnlinkDeveloperIdentity.unlinkDeveloperIdentityUnlinks a
DeveloperUserIdentifierfrom 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.
-
xAmzTargetAwsCognitoIdentityServiceUnlinkIdentity.unlinkIdentityUnlinks 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.
-
xAmzTargetAwsCognitoIdentityServiceUntagResource.untagResourceRemoves the specified tags from the specified Amazon Cognito identity pool. You can use this action up to 5 times per second, per account
-
xAmzTargetAwsCognitoIdentityServiceUpdateIdentityPool.updateIdentityPoolUpdates an identity pool.
You must use AWS Developer credentials to call this API.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools