Assign project and role to user

Available in versions: 2020 SP3 and later

Description

Assigns a specific project and role to a user.

URL

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

Remarks

None

HTTP Method

POST: Assigns a project and role to a specified user.

Request

Headers:

Content-Type: application/xml

Accept: application/json, application/xml

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request Body:

An XML describing details of the user to be assigned.

The fields in the request are:

ElementDescription
UserIDThe ID of the user assigned to the project and role.
ProjectIdThe project ID assigned to the user.
RoleThe name of the role assigned to the user
Copy code
<LRE_Server>/Admin/rest/v1/users/assignUser/2
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<ProjectRole> 
  <ProjectId>4</ProjectId>
  <Role>Viewer</Role>
</ProjectRole> 

Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

Upon successful assignment, returns HTTP status 200 (OK).

See Also

Update a user
Delete a user
Get user by ID
Get all users
Get list of users by query