Add User To Teams

The endpoint Add User To Teams is used to add an existing Leapwork or Active Directory user to multiple teams in the Leapwork application, using userId and TeamIds. After the successful addition into teams, the completed operation is returned in the response. The userId used as the input can be obtained from the Get All Users endpoint with UserType as “Leapwork” or “ActiveDirectory”. The TeamIds used as the input can be obtained from the Get All Teams endpoint. Please note this endpoint will work with the Leapwork Enterprise Edition only.

Request URL

(PUT)

http://{controllerMachine}:{controllerPort}/api/v4/user/{userId}/AddUserToTeams

Input parameters

Examples

Curl

curl -X PUT --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'accessKey: UsctfG8Mg1LVa29L' -d '{ \

   "TeamIds": [ \

     "9fb4ef50-6924-471d-8261-052aa8b572c9","bc53d9e0-6dcd-4eb2-be1d-ccefdf55c1bf" \

   ] \

}' 'http://localhost:9001/api/v4/user/3940e00a-164c-4693-be0b-14ff4746c4a6/AddUserToTeams'

PowerShell 

$headers = @{}
$headers.Add("accessKey","UsctfG8Mg1LVa29L")

$requestBody = @'
{
    "TeamIds": @("9fb4ef50-6924-471d-8261-052aa8b572c9","bc53d9e0-6dcd-4eb2-be1d-ccefdf55c1bf")
}
'@ 

Invoke-WebRequest -Uri "http://localhost:9001/api/v4/user/3940e00a-164c-4693-be0b-14ff4746c4a6/AddUserToTeams" -ContentType "application/json" -Headers $headers -Method PUT -Body $requestBody

Response 

If a user is added successfully to the provided team, it will return a 'true' value. 

{

"$id": "1",

"OperationCompleted": true

}

Response Object

Response Code

• 200 (OK)
• 400 (Bad Request)
• 401 (Unauthorized - eg: “Incorrect Accesskey”)
• 403 (Forbidden – eg: “AccessKey does not have the relevant scope permission”)
• 404 (Not Found – eg: “User not found”, “Team(s) not found”)
• 409 (Conflict – eg: “User exists in team(s)”)
• 500 (Internal Server Error)