v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
Identifiers

Update a login identifier for a user

Updates a login identifier (e.g. from pending to verified) for a user by given userID and identifierID.

patch/users/{userID}/identifiers/{identifierID}

Path parameters

userIDstring required
Example:usr-4693224802260150919

Unique identifier of the user. Format: usr-<number>.

identifierIDstring required
Example:ide-4693224802260150919

Unique identifier of the login identifier (e.g., email address or phone number). Format: ide-<number>.

Request body

status'pending' | 'primary' | 'verified' required

Response

Identifier has been updated.

identifierIDstring required

Unique identifier of the login identifier.

type'email' | 'phone' | 'username' required
valuestring required

Value of the identifier (here email address).

status'pending' | 'primary' | 'verified' required
userIDstring required

Unique identifier of the user.

Example response

{
  "identifierID": "ide-4693224802260150919",
  "value": "jane@doe.com",
  "userID": "usr-4693224802260150919"
}