GetOpenIdTokenForDeveloperIdentityCommand

Suggest an Edit

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 Amazon Web Services developer credentials to call this operation.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { CognitoIdentityClient, GetOpenIdTokenForDeveloperIdentityCommand } from "@aws-sdk/client-cognito-identity"; // ES Modules import
// const { CognitoIdentityClient, GetOpenIdTokenForDeveloperIdentityCommand } = require("@aws-sdk/client-cognito-identity"); // CommonJS import
const client = new CognitoIdentityClient(config);
const input = { // GetOpenIdTokenForDeveloperIdentityInput
  IdentityPoolId: "STRING_VALUE", // required
  IdentityId: "STRING_VALUE",
  Logins: { // LoginsMap // required
    "<keys>": "STRING_VALUE",
  },
  PrincipalTags: { // PrincipalTags
    "<keys>": "STRING_VALUE",
  },
  TokenDuration: Number("long"),
};
const command = new GetOpenIdTokenForDeveloperIdentityCommand(input);
const response = await client.send(command);
// { // GetOpenIdTokenForDeveloperIdentityResponse
//   IdentityId: "STRING_VALUE",
//   Token: "STRING_VALUE",
// };

GetOpenIdTokenForDeveloperIdentityCommand Input

See GetOpenIdTokenForDeveloperIdentityCommandInput for more details

Parameter
Type
Description
IdentityPoolId
Required
string | undefined

An identity pool ID in the format REGION:GUID.

Logins
Required
Record<string, string> | undefined

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

IdentityId
string | undefined

A unique identifier in the format REGION:GUID.

PrincipalTags
Record<string, string> | undefined

Use this operation to configure attribute mappings for custom providers.

TokenDuration
number | undefined

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary Amazon Web Services credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your Amazon Web Services resources for the token's duration.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

GetOpenIdTokenForDeveloperIdentityCommand Output

See GetOpenIdTokenForDeveloperIdentityCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
IdentityId
string | undefined

A unique identifier in the format REGION:GUID.

Token
string | undefined

An OpenID token.

Throws

Name
Fault
Details
DeveloperUserAlreadyRegisteredException
client

The provided developer user identifier is already registered with Cognito under a different identity ID.

InternalErrorException
server

Thrown when the service encounters an error during processing the request.

InvalidParameterException
client

Thrown for missing or bad input parameter(s).

NotAuthorizedException
client

Thrown when a user is not authorized to access the requested resource.

ResourceConflictException
client

Thrown when a user tries to use a login which is already linked to another account.

ResourceNotFoundException
client

Thrown when the requested resource (for example, a dataset or record) does not exist.

TooManyRequestsException
client

Thrown when a request is throttled.

CognitoIdentityServiceException
Base exception class for all service exceptions from CognitoIdentity service.