ESescape
Users

Deactivate or reactivate a user

Deactivate or reactivate a user of the organization. Setting deactivated to true records the deactivation time, false clears it. Requires the ADMIN permission on the target user. The caller cannot deactivate themselves.

put/users/{userId}

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

userIdstring required

The user ID

Example:00000000-0000-0000-0000-000000000000

Request body

deactivatedboolean required

Set to true to deactivate the user, false to reactivate them

Response

OK

idstring uuid required

The id of the user

emailstring email required

The email of the user

createdAtstring date-time required

The date and time the user was created

activatedAtstring date-time nullable required

The date and time the user was activated

deactivatedAtstring date-time nullable required

The date and time the user was deactivated

firstLoginAtstring date-time nullable required

The date and time the user first logged in

lastLoginAtstring date-time nullable required

The date and time the user last logged in

Changes

No recorded changes to this operation across all 1 revision of this API.