users
Deactivate user
Deactivates a person's account. This revokes all of their active sessions, signing them out everywhere immediately and blocking further sign-in including through SSO, and removes them from every location's approver list. This action is reversible. You cannot deactivate your own account or the last remaining account owner. Only an account owner can do this to an owner, and you cannot do it to a person who holds a permission you do not hold. An API key is never an owner.
Notes.
- Only an owner can deactivate an owner, and nobody can deactivate a person who holds a permission they do not hold. An API key is never an owner, whatever its permissions.
post/v1/users/{id}/deactivate
Request
- Base URL: https://api.brixsignage.com
- URL: https://api.brixsignage.com/v1/users/{id}/deactivate
- Auth: HTTP bearer
Path parameters
idstring required
User id.
Response
Success.
Changes
No recorded changes to this operation across all 1 revision of this API.