Skip to content

Cognito Identity  >  Operations  >  get_open_id_token

get_open_id_token

Operation

get_open_id_token async 

get_open_id_token(input: GetOpenIdTokenInput, plugins: list[Plugin] | None = None) -> GetOpenIdTokenOutput

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

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

Parameters:

Name Type Description Default
input GetOpenIdTokenInput

An instance of GetOpenIdTokenInput.

 required
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

Returns:

Type Description
GetOpenIdTokenOutput

An instance of GetOpenIdTokenOutput.

Input

GetOpenIdTokenInput dataclass

Input to the GetOpenIdToken action.

Attributes

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

A unique identifier in the format REGION:GUID.

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

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenID Connect provider, always include the id_token.

Output

GetOpenIdTokenOutput dataclass

Returned in response to a successful GetOpenIdToken request.

Attributes

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

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

token class-attribute instance-attribute 
token: str | None = field(repr=False, default=None)

An OpenID token, valid for 10 minutes.