Users

Delete a user

Deleting a user removes the object entirely. In almost every circumstance it is preferable to suspend a user, as a deleted user can be recreated by signing in with SSO again.

post/users.delete

Request body

idstring uuid required

Unique identifier for the user.

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

Changed in 2 of the 6 revisions of this API.10

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property data to the response with the 401 status

      response-optional-property-added

    • added the optional property data to the response with the 403 status

      response-optional-property-added

    • added the optional property data to the response with the 404 status

      response-optional-property-added

    • added the optional property message to the response with the 401 status

      response-optional-property-added

    • added the optional property message to the response with the 403 status

      response-optional-property-added

    • added the optional property message to the response with the 404 status

      response-optional-property-added

    • added the optional property status to the response with the 401 status

      response-optional-property-added

    • added the optional property status to the response with the 403 status

      response-optional-property-added

    • added the optional property status to the response with the 404 status

      response-optional-property-added