DELETE/depts/{DeptId}/users/{UserId}

Applies to QAComplete 12.70 SaaS, last modified on January 11, 2021

Disables a user profile.

Use this operation to disable a user profile specified by its ID.

The /depts/{DeptId}/users/{UserId} (DELETE) operation can be performed only on the user's primary department.

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must have administrator privileges.

Request Format

To delete a user, send a DELETE request to the following URL:

http://{server}/rest-api/service/api/v1/depts/{DeptId}/users/{UserId}
URL parameters

DeptId  :  integer, required

The ID of the needed department.

Id  :  integer, required

The ID of the user profile you want to disable.

A sample request:

DELETE http://yourserver.com/rest-api/service/api/v1/depts/8162/users/12345 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json, text/script, */*
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword http://yourserver.com/service/api/v1/depts/8162/users/24792

Response Format

If successful, the operation returns an empty response with HTTP status code 200.

Error responses

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

See Also

Users REST API Reference

Highlight search results