users

Deactivates the user.

Changed on

Deactivates the user. 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>

post/users/{userId}/deactivate

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/{userId}/deactivate
  • Auth: HTTP bearer

Path parameters

userIdstring uuid required

The id of the user.

Query parameters

includeSummaryboolean

Whether to return the private project orphan resolution summary.

Response

OK

privateProjectManagersReassignedCountinteger
privateProjectsDeletedCountinteger

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostUserDeactivateByUserId removed and replaced with users_PostUserDeactivateByUserId