merge_developer_identities¶
Operation¶
async
¶
merge_developer_identities(input: MergeDeveloperIdentitiesInput, plugins: list[Plugin] | None = None) -> MergeDeveloperIdentitiesOutput
Merges two users having different IdentityIds, existing in the same
identity pool, and identified by the same developer provider. You can
use this action to request that discrete users be merged and identified
as a single user in the Cognito environment. Cognito associates the
given source user (SourceUserIdentifier) with the IdentityId of the
DestinationUserIdentifier. Only developer-authenticated users can be
merged. If the users to be merged are associated with the same public
provider, but as two different users, an exception will be thrown.
The number of linked logins is limited to 20. So, the number of linked
logins for the source user, SourceUserIdentifier, and the destination
user, DestinationUserIdentifier, together should not be larger than
20. Otherwise, an exception will be thrown.
You must use Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MergeDeveloperIdentitiesInput
|
An instance of |
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 |
|---|---|
MergeDeveloperIdentitiesOutput
|
An instance of |
Input¶
dataclass
¶
Input to the MergeDeveloperIdentities action.
Attributes¶
class-attribute
instance-attribute
¶
destination_user_identifier: str | None = None
User identifier for the destination user. The value should be a
DeveloperUserIdentifier.
class-attribute
instance-attribute
¶
developer_provider_name: str | None = None
The "domain" by which Cognito will refer to your users. This is a
(pseudo) domain name that you provide while creating an identity pool.
This name acts as a placeholder that allows your backend and the Cognito
service to communicate about the developer provider. For the
DeveloperProviderName, you can use letters as well as period (.),
underscore (_), and dash (-).