Update a user's activation state
Activate or deactivate a user. Deactivated users cannot authenticate, sign, or be selected, but remain visible in historical records.
Authorizations
Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.
Path Parameters
The unique ID of the user to update.
Body
Sets the user's activation state.
When false, the user is deactivated; when true, the user is reactivated.
Response
User updated successfully.
A user. List responses populate the lean fields by default and add notary fields and image URLs when requested via the fields mask; the detail views (GET/PUT /v1/users/{userId}) always populate notary fields and image URLs.
The user's unique ID.
The user's display name.
The user's email address.
The user's job title.
The user's phone number.
When the user was deactivated. Absent or null means the user is active.
Download URLs for the user's signature and notary seal images (detail views only).
Whether the user is a notary.
Upload (PUT) URLs returned when an image upload was requested (detail views only). Deprecated — request upload URLs via POST /v1/users/{userId}/images and upload before saving the profile.
