latestOpenAPI 3.0.12026-08-2035981.5 MB

0287c6a59eba

Users

Update user suspension status

Update user suspension status for the given ID.

patch/api/users/{userId}/is-suspended

Path parameters

userIdstring required

The unique identifier of the user.

Request body

isSuspendedboolean required

New suspension status for the user.

Response

User suspension status updated successfully.

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