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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetOpenIdTokenForDeveloperIdentity and EndGetOpenIdTokenForDeveloperIdentity.

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

Syntax

C#
public virtual Task<GetOpenIdTokenForDeveloperIdentityResponse> GetOpenIdTokenForDeveloperIdentityAsync(
         GetOpenIdTokenForDeveloperIdentityRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoIdentity.Model.GetOpenIdTokenForDeveloperIdentityRequest

Container for the necessary parameters to execute the GetOpenIdTokenForDeveloperIdentity service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetOpenIdTokenForDeveloperIdentity service method, as returned by CognitoIdentity.

Exceptions

ExceptionCondition
DeveloperUserAlreadyRegisteredException The provided developer user identifier is already registered with Cognito under a different identity ID.
InternalErrorException Thrown when the service encounters an error during processing the request.
InvalidParameterException Thrown for missing or bad input parameter(s).
NotAuthorizedException Thrown when a user is not authorized to access the requested resource.
ResourceConflictException Thrown when a user tries to use a login which is already linked to another account.
ResourceNotFoundException Thrown when the requested resource (for example, a dataset or record) does not exist.
TooManyRequestsException Thrown when a request is throttled.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also