Share this page
Add a user
Available in versions: 2020 SP3 and later
Description
Creates a new user.
URL
Copy code
/Admin/rest/v1/usersRemarks
None
HTTP Method
POST: Creates a new user.
Request
Headers:
Content-Type: application/xml
Accept: application/json, application/xml
Cookies:
ADM_LWSSO={AdmLwssoCookie};
Request Body:
An XML describing the user.
The fields in the request are:
| Element | Description |
|---|---|
| UserName | The user's name. |
| FullName | The user's full name. |
| Status | The user's status: active or inactive. |
| 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 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 ExampleCopy code
POST http://<LRE_Server>/Admin/rest/v1/users
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
<User>
<UserName>usApi</UserName>
<FullName>User Api</FullName>
<Status>active</Status>
<Password>c2E=</Password>
<PermissionLevel>3</PermissionLevel>
<LDAPUserName>ldapUserName</LDAPUserName>
<UsDomAuth></UsDomAuth>
<UsIsLDAP>false</UsIsLDAP>
</User>
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 project and role to user
Get user by ID
Get all users
Get list of users by query
