roles

Deactivates the user.

Changed on

Deactivates the user. The user's sign-in status changes for the workspace.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:write permissions.</Check>

post/roles/{roleId}/users/{userId}/deactivate

Request

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

Path parameters

roleIdstring uuid required

The id of the role.

userIdstring uuid required

The id of the user.

Response

OK

RolesPostRoleUserDeactivateByRoleIdAndUserIdResponse200 required

Empty response body

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 PostRoleUserDeactivateByRoleIdAndUserId removed and replaced with roles_PostRoleUserDeactivateByRoleIdAndUserId