CloudShare API
CloudShare's API Documentation

Removes user(s) who are not part of any active classes, pocs, or environments, and supports the replacement of users who are part of any active classes, pocs, or environments.

* Each request is limited to one project id, one team id, and one role. Multiple calls should be made if you wish to remove users from different projects, teams within a project, and/or different user roles.

** All body parameters need to coincide in order to implement any changes. The project id, team id, and role must match to the user id.

*** In order to remove an active user, you can replace them with another user. Use the replace user query parameter and the relevant user id to replace and remove users. The replacement user will receive ownership of any end-user environments, policies, and invitations.

Request Path

POST /api/v3/users/Actions/RemoveUserRole?replacingUserId={userId}

Request Payload

{
users: [{id:}, {id:…}],
projectId: ,
teamId: ,
role:
}

Body Parameters

Query Parameters

Request Example

{
    "users": [{id:"USMVysHnO_uN8v0OX8CUhBbq2"}, {id:"USMVysHnO_uN8v0OX8CUhBbq3"}],
    "projectId": "PRjTcEu83MXmpDAHTf47b-QQ2",
    "teamId": "TMXrjiUu7WTjGuctqTUJ0wXQ2",
    "role": 2
}

Response Example

{
    results: [
        {
        invitee :{
	        email: string,
	        firstName: string,
	        lastName: string
	        },
	        success : true/false,
	        errorMsg: string,	
	    },
	    ...
    ]
}

Error Response Example

{
    "message": <string>,
    "code": <string>,
    "exceptionMessage": <string>,
    "exceptionType": <string>,
    "stackTrace": <string>
}

Possible Error strings