latestOpenAPI 3.0.12026-08-2035981.5 MB

0287c6a59eba

Users

Update user

Update user data for the given ID. This method performs a partial update.

patch/api/users/{userId}

Path parameters

userIdstring required

The unique identifier of the user.

Request body

customDataobject

Custom data object to update for the given user ID. Note this will replace the entire custom data object.

If you want to perform a partial update, use the PATCH /api/users/{userId}/custom-data endpoint instead.

Response

Updated user data for the given ID.

idstring required

usernamestring nullable required

primaryEmailstring nullable required

primaryPhonestring nullable required

namestring nullable required

avatarstring nullable required

customDataobject required

arbitrary

identitiesobject required

lastSignInAtnumber nullable required

createdAtnumber required

updatedAtnumber required

applicationIdstring nullable required

cimdClientIdstring nullable required

The identifier of the CIMD (client ID metadata document) client from the user's first consent. null unless the user's first consent was granted to a CIMD client. Mutually exclusive with applicationId.

isSuspendedboolean required

hasPasswordboolean

hasSecurityVerificationMethodboolean

passwordDigeststring nullable