GroupManager_PUT
Creates or updates groups
Defined in: groupManager.js.
Constructor Attributes | Constructor Name and Description |
---|---|
GroupManager_PUT(groups, pretty)
PUT /wf/restapi/v2/admin/groupManager: This endpoint creates groups or updates existing groups.
|
Class Detail
GroupManager_PUT(groups, pretty)
PUT /wf/restapi/v2/admin/groupManager: This endpoint creates groups or updates existing groups.
- Parameters:
- groups
- An array of group objects to create. These objects should have the same structure as collected from GroupManager_GET. If you are creating a new group the "id" parameter is not required, but it is required to update an existing group.
- pretty Optional, Default: false
- format the response to be human readable?
PUT /wf/restapi/v2/admin/groupManager (Creating a new group) Body form-data: groups = [ { "loadingDockType": 10000, "hidden": false, "description": "Group to test creating new groups", "ldapDn": "", "priority": 2, "editLevel": 4, "loginText": "this is displayed on login", "viewLevel": 6, "name": "New Group", "users": [ 1 ] } ] Response: [ { "loadingDockType": 1, "hidden": false, "description": "Group to test creating new groups", "ldapDn": "", "priority": 2, "editLevel": 4, "loginText": "this is displayed on login", "viewLevel": 6, "name": "New Group", "id": 9, "acls": [], "users": [ 1 ] } ]
PUT /wf/restapi/v2/admin/groupManager (Updating the group from the previous example. Updated the description, priority, editLevel, viewLevel, name and users) Body form-data: groups = [ { "loadingDockType": 1, "hidden": false, "description": "Group to test modifying", "ldapDn": "", "priority": 1, "editLevel": 5, "loginText": "this is displayed on login", "viewLevel": 5, "name": "New Group rename", "id": 9, "acls": [], "users": [ 2 ] } ] Response: [ { "loadingDockType": 1, "hidden": false, "description": "Group to test modifying", "ldapDn": "", "priority": 1, "editLevel": 5, "loginText": "this is displayed on login", "viewLevel": 5, "name": "New Group rename", "id": 9, "acls": [], "users": [ 2 ] } ]