get_open_id_token¶
Operation¶
get_open_id_token
¶
get_open_id_token(request: GetOpenIdTokenInput | GetOpenIdTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOpenIdTokenInputDict]) -> 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 |
|---|---|---|---|
request
|
GetOpenIdTokenInput | GetOpenIdTokenInputDict | 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[GetOpenIdTokenInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetOpenIdTokenOutput
|
An instance of |
get_open_id_token
async
¶
get_open_id_token(request: GetOpenIdTokenInput | GetOpenIdTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOpenIdTokenInputDict]) -> 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 |
|---|---|---|---|
request
|
GetOpenIdTokenInput | GetOpenIdTokenInputDict | 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[GetOpenIdTokenInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetOpenIdTokenOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetOpenIdTokenInputDict
¶
Bases: TypedDict
Dictionary form of GetOpenIdTokenInput.
Attributes¶
identity_id
instance-attribute
¶
A unique identifier in the format REGION:GUID.
logins
instance-attribute
¶
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.
GetOpenIdTokenInput
dataclass
¶
Bases: _SerdeShape
Input to the GetOpenIdToken action.
Attributes¶
identity_id
class-attribute
instance-attribute
¶
identity_id: str | None = ...
A unique identifier in the format REGION:GUID.
logins
class-attribute
instance-attribute
¶
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
¶
Bases: _SerdeShape
Returned in response to a successful GetOpenIdToken request.
Attributes¶
identity_id
class-attribute
instance-attribute
¶
identity_id: str | None = ...
A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
response_metadata
class-attribute
instance-attribute
¶
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.