Deactivates the user with the specified id.

POST

https://api.awork.com/api/v1/users/:userId/deactivate

A deactivated user can no longer sign in. This is only possible if the user is not the last admin user.

Required Permissions

The user must be an admin or have user-manage-config:write permissions.

A deactivated user can no longer sign in. This is only possible if the user is not the last admin user. <Check title="Required Permissions" icon="key">The user must be an admin or have `user-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"

The id of the user.

Query parameters

includeSummarybooleanOptionalDefaults to false

Whether to return the private project orphan resolution summary.

Response

privateProjectManagersReassignedCountinteger

privateProjectsDeletedCountinteger

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X POST https://api.awork.com/api/v1/users/userId/deactivate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'