Update a user

Available in versions: 2020 SP3 and later

Description

Edits a specific user.

URL

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

Remarks

None

HTTP Method

PATCH: Edits a specific user.

Request

Headers:

Content-Type: application/xml

Accept: application/json, application/xml

Cookies:

LWSSO_COOKIE_KEY={LwssoCookie};

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:

ElementDescription
UserNameThe user's name.
FullNameThe user's full name.
StatusSpecifies the user's status: active or inactive.
EmailThe user's email address.
PasswordThe user's password encoded in base64.
DescriptionA description of the user.
Permission level

1. Regular user

3. Admin Viewer

7. Tenant Admin

9. Site Admin

LDAPUserNameThe LDAP user name.
UsDomAuthThe user domain authentication.
UsIsLDAPSpecifies whether the user is LDAP: true or false.

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).

See Also

Add a user
Delete a user
Assign user to project and role
Get user by ID
Get all users
Get list of users by query