Update a user

Available in versions: 2020 SP3 and later

Description

Edits a specific user.

URL

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

Remarks

Site Admin can update admins of any permission level.

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

User Admin can update regular users and User Admins, and cannot assign users to projects.

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

HTTP method

PATCH: Edits a specific user.

Request

Headers:

One of the following:

Content-Type: application/xml
Content-Type: application/json

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

An XML describing the data to be updated (include only the fields that you want to be updated in the request).

Below are the user fields that can be updated in the request.

Element	Description
UserName	The user's name.
FullName	The user's full name.
Status	Specifies the user's status: active or inactive.
Email	The user's email address.
Password	The user's password encoded in base64.
Description	A description of the user.
Permission level	1. Regular user 3. Admin Viewer 4. User Admin 5. Application Admin 6. Project Admin 7. Tenant Admin 9. Site Admin
LDAPUserName	The LDAP user name.
UsDomAuth	The user domain authentication.
UsIsLDAP	Specifies whether the user is LDAP: true or false.

Request example:

Copy code

PATCH http://<LRE_Server>/Admin/rest/v1/users/2
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<User> 
  <FullName>updated name</FullName>  
</User>

Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP return codes.

Upon successful update of a user, returns HTTP status 200 (OK).