Group Web Services
Overview
Universal Controller supports the following RESTful-based web services for User and Group operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about parameter requirements, are provided.
Create a Group
| Description |
|---|---|
URI | |
HTTP Method | POST |
Description | Creates a new User Group. |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Create and Modify a Group: XML and JSON Examples, below. |
Group Properties | See Group Properties, below. |
Group Member Properties | See Group Member Properties, below. |
Group Permission Properties | See Group Permission Properties, below. |
Group Role Properties | See Group Role Properties, below. |
Example Response |
|
Create and Modify a Group: XML and JSON Examples
The excludeRelated and retainSysIds properties are specified as attributes in the <userGroup> element of XML web services.
XML | JSON |
|---|---|
<userGroup retainSysIds="true">
<ctrlNavigationVisibility>false</ctrlNavigationVisibility>
<description />
<email />
<groupMembers>
<groupMember>
<sysId>386bf68d82a74a9e94eab18c1b1844c2</sysId>
<user name="stone b branch">stonebranch-user-02</user>
</groupMember>
<groupMember>
<sysId>792aa1dc1a1b4decb0b02d82ed7e9422</sysId>
<user name="stone c branch">stonebranch-user-03</user>
</groupMember>
<groupMember>
<sysId>b78079e1166d4c5180d7e42443de44a0</sysId>
<user name="stone a branch">stonebranch-user-01</user>
</groupMember>
</groupMembers>
<groupRoles>
<groupRole>
<role description="The administrator role.">ops_admin</role>
<sysId>b80e78a42589435f92f3e176af6dc542</sysId>
</groupRole>
</groupRoles>
<manager />
<name>stonebranch-group-01</name>
<navigationVisibility/>
<parent />
<permissions>
<permission>
<allGroups>true</allGroups>
<commands />
<defaultGroup>true</defaultGroup>
<nameWildcard>*</nameWildcard>
<notGroups>false</notGroups>
<opCreate>false</opCreate>
<opDelete>false</opDelete>
<opExecute>false</opExecute>
<opRead>true</opRead>
<opUpdate>false</opUpdate>
<opswiseGroups/>
<permissionType>Task Instance</permissionType>
<sysId>59e5565c9f6a45ed8633d05a91ac1019</sysId>
</permission>
</permissions>
<sysId>b39b2b8eac644e068a68f92f325b0c74</sysId>
</userGroup> | {
"ctrlNavigationVisibility" : false,
"description" : null,
"email" : null,
"groupMembers" : [ {
"sysId" : "386bf68d82a74a9e94eab18c1b1844c2",
"user" : {
"name" : "stone b branch",
"value" : "stonebranch-user-02"
}
}, {
"sysId" : "792aa1dc1a1b4decb0b02d82ed7e9422",
"user" : {
"name" : "stone c branch",
"value" : "stonebranch-user-03"
}
}, {
"sysId" : "b78079e1166d4c5180d7e42443de44a0",
"user" : {
"name" : "stone a branch",
"value" : "stonebranch-user-01"
}
} ],
"groupRoles" : [ {
"role" : {
"description" : "The administrator role.",
"value" : "ops_admin"
},
"sysId" : "b80e78a42589435f92f3e176af6dc542"
} ],
"manager" : null,
"name" : "stonebranch-group-01",
"navigationVisibility" : [ ],
"parent" : null,
"permissions" : [ {
"allGroups" : true,
"commands" : null,
"defaultGroup" : true,
"nameWildcard" : "*",
"notGroups" : false,
"opCreate" : false,
"opDelete" : false,
"opExecute" : false,
"opRead" : true,
"opUpdate" : false,
"opswiseGroups" : [ ],
"permissionType" : "Task Instance",
"sysId" : "59e5565c9f6a45ed8633d05a91ac1019"
} ],
"retainSysIds" : true,
"sysId" : "b39b2b8eac644e068a68f92f325b0c74"
} |
Delete a Group
| Description |
|---|---|
URI | |
HTTP Method | DELETE |
Description | Deletes a Group. |
URI Parameters | See Group Delete a Group URI Parameters, below. |
Example URI | |
Example Response |
|
Delete a Group: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|
| ID used within the Controller to identify this group. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this group. | String; URI parameter. | Y (unless |
|