CognitoIdentityClient Class

Member Function Documentation

CognitoIdentityClient::CognitoIdentityClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a CognitoIdentityClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

CognitoIdentityClient::CognitoIdentityClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads CognitoIdentityClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CreateIdentityPoolResponse *CognitoIdentityClient::createIdentityPool(const CreateIdentityPoolRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an CreateIdentityPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>SupportedLoginProviders</code> are as

follows> <ul> <li>

Facebook: <code>graph.facebook.com</code>

</p </li> <li>

Google: <code>accounts.google.com</code>

</p </li> <li>

Amazon: <code>www.amazon.com</code>

</p </li> <li>

Twitter: <code>api.twitter.com</code>

</p </li> <li>

Digits: <code>www.digits.com</code>

</p </li> </ul>

You must use AWS Developer credentials to call this

[slot] DeleteIdentitiesResponse *CognitoIdentityClient::deleteIdentities(const DeleteIdentitiesRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an DeleteIdentitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteIdentityPoolResponse *CognitoIdentityClient::deleteIdentityPool(const DeleteIdentityPoolRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an DeleteIdentityPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a user 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

[slot] DescribeIdentityResponse *CognitoIdentityClient::describeIdentity(const DescribeIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an DescribeIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeIdentityPoolResponse *CognitoIdentityClient::describeIdentityPool(const DescribeIdentityPoolRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an DescribeIdentityPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetCredentialsForIdentityResponse *CognitoIdentityClient::getCredentialsForIdentity(const GetCredentialsForIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an GetCredentialsForIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetIdResponse *CognitoIdentityClient::getId(const GetIdRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an GetIdResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetIdentityPoolRolesResponse *CognitoIdentityClient::getIdentityPoolRoles(const GetIdentityPoolRolesRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an GetIdentityPoolRolesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the roles for an identity

pool>

You must use AWS Developer credentials to call this

[slot] GetOpenIdTokenResponse *CognitoIdentityClient::getOpenIdToken(const GetOpenIdTokenRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an GetOpenIdTokenResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by <a>GetId</a>. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit

link>

The OpenId token is valid for 15

minutes>

This is a public API. You do not need any credentials to call this

[slot] GetOpenIdTokenForDeveloperIdentityResponse *CognitoIdentityClient::getOpenIdTokenForDeveloperIdentity(const GetOpenIdTokenForDeveloperIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an GetOpenIdTokenForDeveloperIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers (or retrieves) a Cognito <code>IdentityId</code> 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 <code>Logins</code> 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 <code>GetOpenIdTokenForDeveloperIdentity</code> 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 <code>IdentityId</code> 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 <code>IdentityId</code>. This API will create the identity in the specified

<code>IdentityPoolId</code>>

You must use AWS Developer credentials to call this

[slot] ListIdentitiesResponse *CognitoIdentityClient::listIdentities(const ListIdentitiesRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an ListIdentitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the identities in a

pool>

You must use AWS Developer credentials to call this

[slot] ListIdentityPoolsResponse *CognitoIdentityClient::listIdentityPools(const ListIdentityPoolsRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an ListIdentityPoolsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all of the Cognito identity pools registered for your

account>

You must use AWS Developer credentials to call this

[slot] LookupDeveloperIdentityResponse *CognitoIdentityClient::lookupDeveloperIdentity(const LookupDeveloperIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an LookupDeveloperIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the <code>IdentityID</code> associated with a <code>DeveloperUserIdentifier</code> or the list of <code>DeveloperUserIdentifier</code>s associated with an <code>IdentityId</code> for an existing identity. Either <code>IdentityID</code> or <code>DeveloperUserIdentifier</code> 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, <code>DeveloperUserIdentifier</code> will be matched against <code>IdentityID</code>. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a <code>ResourceConflictException</code> is

thrown>

You must use AWS Developer credentials to call this

[slot] MergeDeveloperIdentitiesResponse *CognitoIdentityClient::mergeDeveloperIdentities(const MergeDeveloperIdentitiesRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an MergeDeveloperIdentitiesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Merges two users having different <code>IdentityId</code>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 (<code>SourceUserIdentifier</code>) with the <code>IdentityId</code> of the <code>DestinationUserIdentifier</code>. 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>

You must use AWS Developer credentials to call this

[slot] SetIdentityPoolRolesResponse *CognitoIdentityClient::setIdentityPoolRoles(const SetIdentityPoolRolesRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an SetIdentityPoolRolesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sets the roles for an identity pool. These roles are used when making calls to <a>GetCredentialsForIdentity</a>

action>

You must use AWS Developer credentials to call this

[slot] UnlinkDeveloperIdentityResponse *CognitoIdentityClient::unlinkDeveloperIdentity(const UnlinkDeveloperIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an UnlinkDeveloperIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Unlinks a <code>DeveloperUserIdentifier</code> 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

[slot] UnlinkIdentityResponse *CognitoIdentityClient::unlinkIdentity(const UnlinkIdentityRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an UnlinkIdentityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateIdentityPoolResponse *CognitoIdentityClient::updateIdentityPool(const UpdateIdentityPoolRequest &request)

Sends request to the CognitoIdentityClient service, and returns a pointer to an UpdateIdentityPoolResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates a user

pool>

You must use AWS Developer credentials to call this