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://host_name/uc/resources/usergroup |
HTTP Method |
POST |
Description |
Creates a new User Group. |
Example URI |
http://localhost:8080/uc/resources/usergroup |
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 |
---|---|
|
|
Delete a Group
|
Description |
---|---|
URI |
http://host_name/uc/resources/usergroup |
HTTP Method |
DELETE |
Description |
Deletes a Group. |
URI Parameters |
See 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 |
|
List Groups
|
Description |
---|---|
URI |
http://host_name/uc/resources/usergroup/list |
HTTP Method |
GET |
Description |
Retrieves information on all Groups. |
Example URI |
http://localhost:8080/uc/resources/usergroup/list |
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Example |
|
Group Properties |
See Group Properties. |
Group Member Properties |
|
Group Permission Properties |
|
Group Role Properties |
List Groups XML and JSON Examples
XML |
JSON |
---|---|
|
|
Modify a Group
|
Description |
---|---|
URI |
http://host_name/uc/resources/usergroup |
HTTP Method |
PUT |
Description |
Modifies the Group specified by the |
Example URI |
http://localhost:8080/uc/resources/usergroup |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example Request |
|
Group Properties |
See Group Properties. |
Group Member Properties |
|
Group Permission Properties |
|
Group Role Properties |
|
Example Response |
|
Read a Group
|
Description |
---|---|
URI |
http://host_name/uc/resources/usergroup |
HTTP Method |
GET |
Description |
Retrieves information on a specific Group. |
URI Parameters |
See Read a Group: URI Parameters, below. |
Example URI |
|
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
Example Response |
|
Response Group Member Properties |
|
Response Group Permission Properties |
|
Response Group Role Properties |
Read 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 |
|
Read a Group XML and JSON Examples
The retainSysIds property is specified as an attribute in the <userGroup> element of the XML response.
XML |
JSON |
---|---|
|
|
Properties
Group Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Control Navigation Visibility |
Indication of whether or not to control the visibility of navigation pane entries in the Controller Navigator, via the |
Boolean. Valid values: true/false. Default is false. |
N |
|
Description |
Description of the group. |
|
N |
|
|
Email address of this group. |
|
N |
|
n/a |
For the Modify Group web service; specification for whether or not to exclude related records (Group Roles, Group Members, Group Permissions) from the update, even if they are provided in the request. Note In XML, |
Valid values: true/false (default is false). |
N |
|
n/a |
Users in this group. Note Universal Controller only supports a user being a member of 1,000 groups or less. |
Format: <groupMembers> <groupMember> <user>userc</user> </groupMember> </groupMembers> "groupMembers": [ { "user": "userc" } ] |
N |
|
n/a |
Roles assigned to this group. |
Format: <groupRoles> <groupRole> <role>ops_report_admin</role> </groupRole> </groupRoles> "groupRoles": [ { "role": "ops_report_global" } ] |
N |
|
Manager |
ID of the Universal Controller user that is the manager of this group. |
|
N |
|
Name |
Name of the group. |
|
Y |
|
Navigation Visibility |
List of all Controller Navigator entries. |
Format: <navigationVisibility> <navigationNode>Reports</navigationNode> </navigationVisibility> To include all values, set the <navigationVisibility> <navigationNode>All</navigationNode> </navigationVisibility> "navigationVisibility": [ "Reports", "Support Portal" ] |
N |
|
Parent |
Name of this group's parent group, if any. |
|
N |
|
n/a |
Permissions assigned to this group. |
|
N |
|
n/a |
For Create and Read web services; specification for whether or not the web service should persist the sysId property.
Note In XML, |
Valid values: true/false (default is true). |
N |
|
n/a |
System ID field in the database for this record. |
Persisted only if retainSysIds is set to true. |
N |
navigationNode Valid Values
Values |
Navigation Panel |
---|---|
|
All navigation panels |
|
Automation Center |
|
Reporting |
|
Agents & Connections |
|
Bundles & Promotion |
|
Administration |
Group Member Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
n/a |
System ID field in the database for this record. |
|
N |
|
User |
User name of a group member. |
|
Y |
Group Permission Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Member of Any Business Service or Unassigned |
Specification for whether or not this permission applies both to records that belong to any Business Service and to records that do not belong to any Business Service. |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Commands |
Commands that are associated with each permission. |
Valid values: see Command Permissions, below. |
N |
|
Unassigned to Business Service |
Specification for whether or not this permission applies to records that do not belong to any Business Service. |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Name |
Specification to apply this permission to records whose name matches the string specified here. |
Wildcards (*'s) can be used. |
Y |
|
Create |
Allows members of the group to create records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Delete |
Allows members of the group to delete records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Execute |
Allows the user to execute records of the specified |
Boolean. Valid Values: true/false. Default is false.
If the Strict Connection Execute Constraints Universal Controller system property is true:
|
N |
|
Read |
Allows the user to read records of the specified |
Boolean. Valid Values: true/false. Default is false.
|
N |
|
Update |
Allows members of the group to update records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Member of Business Services |
Applies this permission to records that are members of the selected Business Service(s). |
Format: <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> "opswiseGroups": ["test"] |
N |
|
Type |
Type of permission for this group. |
Valid values:
|
Y |
|
n/a |
System ID field in the database for this record. |
Persisted only if retainSysIds is set to true. |
N |
Command Permissions
Permission Type |
Commands |
---|---|
Agent |
|
Agent Cluster |
|
Application |
|
Bundle |
|
Calendar |
|
Credential |
|
Database Connection |
|
Email Connection |
|
Email Template |
|
OMS Server |
|
PeopleSoft Connection |
|
Promotion Target |
|
SAP Connection |
|
Script |
|
SNMP Manager |
|
Task |
|
Task Instance |
|
Trigger |
|
Variable |
|
Virtual Resource |
|
Group Role Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
Role |
Role assigned to this group. |
|
Y |
|
n/a |
System ID field in the database for this record. |
|
N |