Unassign user from projects

Available in versions: 2023 R1 and later

Description

Unassigns a user (specified by ID) from a specific project.

URL

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

Remarks

This API should be authorized for the Project Admin, Application Admin, Tenant Admin, and Site Admin permission levels.

HTTP method

POST: Unassigns a user (specified by ID) from a specific project.

Request

Headers:

One of the following:

  • Content-Type: application/xml

  • Content-Type: application/json

Cookies:

ADM_LWSSO={AdmLwssoCookie};

Request body:

An XML or JSON listing the project from which the user will be unassigned.

The fields in the request are:

ElementDescription
ProjectIdThe ID of the project from which the user should be unassigned

Request examples:

Copy code
XML example:
<LRE_Server>/Admin/rest/v1/users/unassignUser/1003
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<UserProjectUnassignment>
<ProjectId>1011</ProjectId>
</UserProjectUnassignment>
Copy code
JSON example:
<LRE_Server>/Admin/rest/v1/users/unassignUser/1003
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};

{
        "ProjectId": "1011" 
}

Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP return codes.

Upon successful unassignment, returns HTTP status 204 (No content).

See also: