Skip to main content
POST
Merges one or more user identities into a primary user identity, for when the same person ended up with more than one user identity. The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as merged_user_identity_ids and merged_user_identity_keys. Access grants, access system users, client sessions and other resources belonging to the merged user identities are moved to the primary user identity. Identify the user identities either by ID or by key, but not both in the same request. Repeating a merge that has already been applied makes no further changes. You must include at least one request parameter.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
merged_user_identity_ids
string<uuid>[]
required

IDs of the user identities to merge into the primary user identity. These user identities are deleted.

Required array length: 1 - 20 elements
​
user_identity_id
string<uuid>
required

ID of the primary user identity to keep.

Response

OK

The response is of type object.