AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing CognitoIdentity Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), 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.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CognitoIdentity.AmazonCognitoIdentityClient

Namespace: Amazon.CognitoIdentity
Assembly: AWSSDK.CognitoIdentity.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCognitoIdentityClient : AmazonServiceClient
         IAmazonCognitoIdentity, IAmazonService, IDisposable

The AmazonCognitoIdentityClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCognitoIdentityClient()

Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCognitoIdentityClient(RegionEndpoint)

Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCognitoIdentityClient(AmazonCognitoIdentityConfig)

Constructs AmazonCognitoIdentityClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCognitoIdentityClient(AWSCredentials)

Constructs AmazonCognitoIdentityClient with AWS Credentials

Public Method AmazonCognitoIdentityClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCognitoIdentityClient with AWS Credentials

Public Method AmazonCognitoIdentityClient(AWSCredentials, AmazonCognitoIdentityConfig)

Constructs AmazonCognitoIdentityClient with AWS Credentials and an AmazonCognitoIdentityClient Configuration object.

Public Method AmazonCognitoIdentityClient(string, string)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCognitoIdentityClient(string, string, RegionEndpoint)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCognitoIdentityClient(string, string, AmazonCognitoIdentityConfig)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object.

Public Method AmazonCognitoIdentityClient(string, string, string)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCognitoIdentityClient(string, string, string, RegionEndpoint)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCognitoIdentityClient(string, string, string, AmazonCognitoIdentityConfig)

Constructs AmazonCognitoIdentityClient with AWS Access Key ID, AWS Secret Key and an AmazonCognitoIdentityClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateIdentityPool(CreateIdentityPoolRequest)

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.

Public Method CreateIdentityPoolAsync(CreateIdentityPoolRequest, CancellationToken)

Initiates the asynchronous execution of the CreateIdentityPool operation.

Public Method DeleteIdentities(DeleteIdentitiesRequest)

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.

Public Method DeleteIdentitiesAsync(DeleteIdentitiesRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIdentities operation.

Public Method DeleteIdentityPool(string)

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 API.

Public Method DeleteIdentityPool(DeleteIdentityPoolRequest)

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 API.

Public Method DeleteIdentityPoolAsync(string, CancellationToken)

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 API.

Public Method DeleteIdentityPoolAsync(DeleteIdentityPoolRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIdentityPool operation.

Public Method DescribeIdentity(string)

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.

Public Method DescribeIdentity(DescribeIdentityRequest)

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.

Public Method DescribeIdentityAsync(string, CancellationToken)

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.

Public Method DescribeIdentityAsync(DescribeIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIdentity operation.

Public Method DescribeIdentityPool(string)

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.

Public Method DescribeIdentityPool(DescribeIdentityPoolRequest)

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.

Public Method DescribeIdentityPoolAsync(string, CancellationToken)

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.

Public Method DescribeIdentityPoolAsync(DescribeIdentityPoolRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeIdentityPool operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetCredentialsForIdentity(string)

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.

Public Method GetCredentialsForIdentity(string, Dictionary<String, String>)

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.

Public Method GetCredentialsForIdentity(GetCredentialsForIdentityRequest)

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.

Public Method GetCredentialsForIdentityAsync(string, CancellationToken)

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.

Public Method GetCredentialsForIdentityAsync(string, Dictionary<String, String>, CancellationToken)

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.

Public Method GetCredentialsForIdentityAsync(GetCredentialsForIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the GetCredentialsForIdentity operation.

Public Method GetId(GetIdRequest)

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.

Public Method GetIdAsync(GetIdRequest, CancellationToken)

Initiates the asynchronous execution of the GetId operation.

Public Method GetIdentityPoolRoles(string)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Public Method GetIdentityPoolRoles(GetIdentityPoolRolesRequest)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Public Method GetIdentityPoolRolesAsync(string, CancellationToken)

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

Public Method GetIdentityPoolRolesAsync(GetIdentityPoolRolesRequest, CancellationToken)

Initiates the asynchronous execution of the GetIdentityPoolRoles operation.

Public Method GetOpenIdToken(string)

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 15 minutes.

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

Public Method GetOpenIdToken(GetOpenIdTokenRequest)

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 15 minutes.

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

Public Method GetOpenIdTokenAsync(string, CancellationToken)

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 15 minutes.

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

Public Method GetOpenIdTokenAsync(GetOpenIdTokenRequest, CancellationToken)

Initiates the asynchronous execution of the GetOpenIdToken operation.

Public Method GetOpenIdTokenForDeveloperIdentity(GetOpenIdTokenForDeveloperIdentityRequest)

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.

Public Method GetOpenIdTokenForDeveloperIdentityAsync(GetOpenIdTokenForDeveloperIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the GetOpenIdTokenForDeveloperIdentity operation.

Public Method ListIdentities(ListIdentitiesRequest)

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Public Method ListIdentitiesAsync(ListIdentitiesRequest, CancellationToken)

Initiates the asynchronous execution of the ListIdentities operation.

Public Method ListIdentityPools(ListIdentityPoolsRequest)

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

You must use AWS Developer credentials to call this API.

Public Method ListIdentityPoolsAsync(ListIdentityPoolsRequest, CancellationToken)

Initiates the asynchronous execution of the ListIdentityPools operation.

Public Method LookupDeveloperIdentity(LookupDeveloperIdentityRequest)

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers 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.

You must use AWS Developer credentials to call this API.

Public Method LookupDeveloperIdentityAsync(LookupDeveloperIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the LookupDeveloperIdentity operation.

Public Method MergeDeveloperIdentities(MergeDeveloperIdentitiesRequest)

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.

You must use AWS Developer credentials to call this API.

Public Method MergeDeveloperIdentitiesAsync(MergeDeveloperIdentitiesRequest, CancellationToken)

Initiates the asynchronous execution of the MergeDeveloperIdentities operation.

Public Method SetIdentityPoolRoles(string, Dictionary<String, String>)

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.

Public Method SetIdentityPoolRoles(SetIdentityPoolRolesRequest)

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.

Public Method SetIdentityPoolRolesAsync(string, Dictionary<String, String>, CancellationToken)

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.

Public Method SetIdentityPoolRolesAsync(SetIdentityPoolRolesRequest, CancellationToken)

Initiates the asynchronous execution of the SetIdentityPoolRoles operation.

Public Method UnlinkDeveloperIdentity(UnlinkDeveloperIdentityRequest)

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.

Public Method UnlinkDeveloperIdentityAsync(UnlinkDeveloperIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the UnlinkDeveloperIdentity operation.

Public Method UnlinkIdentity(UnlinkIdentityRequest)

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.

Public Method UnlinkIdentityAsync(UnlinkIdentityRequest, CancellationToken)

Initiates the asynchronous execution of the UnlinkIdentity operation.

Public Method UpdateIdentityPool(UpdateIdentityPoolRequest)

Updates a user pool.

You must use AWS Developer credentials to call this API.

Public Method UpdateIdentityPoolAsync(UpdateIdentityPoolRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateIdentityPool operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone