Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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:

Link copied to clipboard

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

Link copied to clipboard

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

Link copied to clipboard

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

Link copied to clipboard

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun CognitoIdentityClient.getId(crossinline block: GetIdRequest.Builder.() -> Unit): GetIdResponse

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

Link copied to clipboard

Gets the roles for an identity pool.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Use GetPrincipalTagAttributeMap to list all mappings between PrincipalTags and user attributes.

Link copied to clipboard

Lists the identities in an identity pool.

Link copied to clipboard

Lists all of the Cognito identity pools registered for your account.

Link copied to clipboard

Lists the tags that are assigned to an Amazon Cognito identity pool.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

Link copied to clipboard

You can use this operation to use default (username and clientID) attribute or custom attribute mappings.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Updates an identity pool.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.