Delete a user

Available in versions: 2020 SP3 and later

Description

Deletes a user according to the user's ID.

URL

Copy code
/Admin/rest/v1/users/{userID}

Remarks

Site Admin can create admins of any permission level.

Tenant Admin cannot create Site Admin, Admin Viewer, and Application Admin.

User Admin can create only User Admins, and cannot assign users to projects.

Application and Project Admins are not permitted to create any user; they can only assign users to projects with performance test roles.

HTTP method

DELETE: Deletes the specified user.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

None

Request examples:

Copy code
XML example:
DELETE http://<LRE_Server>/Admin/rest/v1/users/2
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
JSON example:
DELETE http://<LRE_Server>/Admin/rest/v1/users/2
Content-Type: application/JSON
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP return codes.

Upon successful user deletion, returns HTTP status 200 (OK).

See also: