Add a user

Available in versions: 2020 SP3 and later

Description

Creates a new user.

URL

Copy code
/Admin/rest/v1/users

Remarks

None

HTTP Method

POST: Creates a new user.

Request

Headers:

Content-Type: application/xml

Accept: application/json, application/xml

Cookies:

LWSSO_COOKIE_KEY={LwssoCookie};

Request Body:

An XML describing the user.

The fields in the request are:

ElementDescription
UserNameThe user's name.
FullNameThe user's full name.
StatusThe 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 creation of user, returns HTTP status 201 (Created).

HTML Body:

Returns data on the new user entity in the response.

See Also

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