Skip to content

get_open_id_token_for_developer_identity

Operation

get_open_id_token_for_developer_identity

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.

Parameters:

Name Type Description Default
request GetOpenIdTokenForDeveloperIdentityInput | GetOpenIdTokenForDeveloperIdentityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetOpenIdTokenForDeveloperIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOpenIdTokenForDeveloperIdentityOutput

An instance of GetOpenIdTokenForDeveloperIdentityOutput.

get_open_id_token_for_developer_identity async

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.

Parameters:

Name Type Description Default
request GetOpenIdTokenForDeveloperIdentityInput | GetOpenIdTokenForDeveloperIdentityInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetOpenIdTokenForDeveloperIdentityInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOpenIdTokenForDeveloperIdentityOutput

An instance of GetOpenIdTokenForDeveloperIdentityOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetOpenIdTokenForDeveloperIdentityInputDict

Bases: TypedDict

Dictionary form of GetOpenIdTokenForDeveloperIdentityInput.

Attributes

identity_id instance-attribute
identity_id: str | None

A unique identifier in the format REGION:GUID.

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

logins instance-attribute
logins: Required[Mapping[str, str]]

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.

principal_tags instance-attribute
principal_tags: Mapping[str, str] | None

Use this operation to configure attribute mappings for custom providers.

token_duration instance-attribute
token_duration: int | None

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.

Note

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

GetOpenIdTokenForDeveloperIdentityInput dataclass

Bases: _SerdeShape

Input to the GetOpenIdTokenForDeveloperIdentity action.

Attributes

identity_id class-attribute instance-attribute
identity_id: str | None = ...

A unique identifier in the format REGION:GUID.

identity_pool_id class-attribute instance-attribute
identity_pool_id: str | None = ...

An identity pool ID in the format REGION:GUID.

logins class-attribute instance-attribute
logins: dict[str, str] | None = ...

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.

principal_tags class-attribute instance-attribute
principal_tags: dict[str, str] | None = ...

Use this operation to configure attribute mappings for custom providers.

token_duration class-attribute instance-attribute
token_duration: int | None = ...

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.

Note

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

Output

GetOpenIdTokenForDeveloperIdentityOutput dataclass

Bases: _SerdeShape

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

Attributes

identity_id class-attribute instance-attribute
identity_id: str | None = ...

A unique identifier in the format REGION:GUID.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

token class-attribute instance-attribute
token: str | None = ...

An OpenID token.