[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Expand]Getting Started/viewarticle/80359/
 [Expand]Collaborator Server/viewarticle/80060/
 [Expand]Web Client/viewarticle/80107/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Collapse]External Integrations/viewarticle/80340/
  [Expand]Creating Custom Reports/viewarticle/80367/
   Bug-Tracking Integration/viewarticle/80405/
  [Expand]JIRA Integration/viewarticle/80130/
  [Expand]GitHub Integration/viewarticle/80343/
  [Expand]Bitbucket Integration/viewarticle/91115/
  [Expand]Scripting/viewarticle/80313/
  [Collapse]Web Services/viewarticle/80412/
    SOAP API Web Services/viewarticle/80422/
   [Collapse]JSON API Web Services/viewarticle/80419/
     Using JSON API Web Service/viewarticle/80421/
     JSON Syntax and Data Formats/viewarticle/80423/
     Authentication/viewarticle/80424/
     Error Handling/viewarticle/80420/
     JSON API Reference/viewarticle/80417/
    [Collapse]How To/viewarticle/80418/
      Manage Reviews and Review Participants/viewarticle/80426/
      Upload Review Materials/viewarticle/80427/
      Manage Users and User Groups/viewarticle/80408/
 [Expand]Techniques & Best Practices/viewarticle/80403/
 [Expand]Appendices/viewarticle/80117/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

External Integrations > Web Services > JSON API Web Services > How To

Top |Previous |Next

Manage Users and User Groups

To perform administrative operations over the users of Collaborator server use the UserService interface. It has methods for creating, editing and deleting users and user subscriptions.

To perform administrative operations over user groups use the GroupService interface. It has methods for creating, editing and deleting groups, adding subgroups, add users to groups, excluding users from groups and so forth.

To call any of the UserService or GroupService commands the current user (that is a user who requests to run the command) must have administrator privileges on the Collaborator server.

Create new user

To create new user, we will call the UserService.create command. It has two obligatory parameters: login and password. Additionally you can enter the users full name (fullName), phone number (phone), email (email) and specify whether it will be an active user (enabled) and whether the user will have administrative privileges (admin).

[ {"command" : "SessionService.authenticate",

"args":{"login":"jsmith","ticket":"0123456789abcdef0123456789abcdef"}},

{"command" : "UserService.create", "args" : {

"login" : "alice",

"password" : "alice",

"fullName" : "alice alice",

"phone" : "345345345",

"email" : "alice@alice.com",

"enabled" : "true",

"admin" : "false"}

}

]

Add user to a group

To add a user to some existing group, we will call the GroupService.addUser command. The command has two parameters: a login of a user to be added (memberLogin) and group identifier (guid).

[ {"command" : "SessionService.authenticate",

"args":{"login":"jsmith","ticket":"0123456789abcdef0123456789abcdef"}},

{ "command" : "GroupService.addUser",

"args" : {

"memberLogin" : "alice",

"guid" : "549ce60e-ea35-46fb-9e39-54529a049abf" }

}

]




© 2019 SmartBear Software. All rights reserved.
Email Send feedback on this document