Suspend a user
POST/v1/directory/people/{person_id}/suspend
Stops an active person signing in and ends their sessions. Their roles and groups stay, ready for Activate.
Permission: identity:SuspendUser. Changes need a sign-in that used a second factor.
Path parameters
| Parameter | Type | Description |
|---|---|---|
person_id |
string | The person's ID. |
Returns
204 No Content, with no body.
Errors
Besides the errors every call can return:
| Status | When |
|---|---|
404 |
No such resource in your organization. |
409 |
You can't suspend yourself, or it would leave your organization with no administrator. |
Example
curl -X POST https://<company>.yotta.bot/v1/directory/people/8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10/suspend \
-H "Authorization: Bearer $YOTTABOT_TOKEN"With yottactl
yottactl org users suspend 8f0c2c1e-6b1a-4f3e-9a51-0c3d2f7e9b10