Versions Compared

Old Version 6

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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

  • Status 200 /OK
    Successfully created the group with sysId {sysId}.

Anchor
Create and Modify a Group XML and JSON Examples
Create and Modify a Group XML and JSON Examples
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


Expand
titleXML


<userGroup retainSysIds="true">
  <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
  <description>Description</description>
  <email>test@stonebranch.com</email>
  <groupMembers>
     <groupMember>
        <sysId>1fe28873315d4316ad8fec7c89477723</sysId>
        <user>userc</user>
     </groupMember>
     <groupMember>
        <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
        <user>userb</user>
     </groupMember>
  </groupMembers>
  <groupRoles>
     <groupRole>
	<role>ops_report_admin</role>
	<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
     </groupRole>
  </groupRoles>
  <manager />
  <name>test</name>
  <navigationVisibility>
     <navigationNode>Reports</navigationNode>
  </navigationVisibility>
  <parent />
  <permissions>
     <permission>
	<allGroups>true</allGroups>
	<commands />
	<defaultGroup>true</defaultGroup>
	<nameWildcard>*</nameWildcard>
	<opCreate>true</opCreate>
	<opDelete>true</opDelete>
	<opExecute>false</opExecute>
	<opRead>true</opRead>
	<opUpdate>true</opUpdate>
	<opswiseGroups />
	<permissionType>Task</permissionType>
	<sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
     </permission>
		...
  </permissions>
  <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
</userGroup>



Expand
titleJSON


{
  "ctrlNavigationVisibility": true,
  "description": "Description",
  "email": "test@stonebranch.com",
  "groupMembers": [ {
    "sysId": "b6fd058ee3db424ea374109299949b18",
    "user": "userc"
  },{
    "sysId": "c54e8898f3bb493e9f5ed7f030007e2e",
    "user": "userb"
  } ],
  "groupRoles": [ {
    "role": "ops_report_admin",
  "sysId": "4112408600e947b89d051d36bf9cf6b3"
  } ],
  "manager": null,
  "name": "test",
  "navigationVisibility": [ "Reports" ],
  "parent": null,
  "permissions": [ {
    "allGroups": true,
    "commands": null,
    "defaultGroup": true,
    "nameWildcard": "*",
    "opCreate": true,
    "opDelete": true,
    "opExecute": false,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Task",
    "sysId": "48eb7ec0c0a8026e0da9406feb022f4e"
  } ],
  "retainSysIds": true,
  "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
}


...


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

See Read a Group: XML and JSON Examples.

Group Properties

See Group Properties.

Group Member Properties

See Group Member Properties.

Group Permission Properties

See Group Permission Properties.

Group Role Properties

See Group Role Properties.

...

XML

JSON


Expand
titleXML


<userGroups>
  <userGroup>
     <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
     <description>Description</description>
     <email>test@stonebranch.com</email>
     <groupMembers>
        <groupMember>
           <sysId>1fe28873315d4316ad8fec7c89477723</sysId>
           <user name="User C">userc</user>
        </groupMember>
        <groupMember>
           <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
           <user name="User B">userb</user>
        </groupMember>
     </groupMembers>
     <groupRoles>
        <groupRole>
	   <role description="report admin role">ops_report_admin</role>
	   <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </groupRoles>
     <manager />
     <name>test1</name>
     <navigationVisibility>
        <navigationNode>Reports</navigationNode>
     </navigationVisibility>
     <parent />
     <permissions>
        <permission>
	   <allGroups>true</allGroups>
	   <commands />
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>true</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>false</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Task</permissionType>
	   <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </permissions>
     <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>
   <userGroup>
     <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
     <description>Description</description>
     <groupMembers />
     <groupRoles>
        <groupRole>
	   <role description="report admin role">ops_report_admin</role>
	   <sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
        </groupRole>
     </groupRoles>
     <manager />
     <name>test2</name>
     <navigationVisibility>
        <navigationNode>Reports</navigationNode>
     </navigationVisibility>
     <parent />
     <permissions>
        <permission>
	   <allGroups>true</allGroups>
	   <commands />
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>true</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>false</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Task</permissionType>
	   <sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
        </permission>
     </permissions>
     <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
   </userGroup>



Expand
titleJSON


[ 
  {
     "ctrlNavigationVisibility": true,
     "description": "Description",
     "email": "test@stonebranch.com",
     "groupMembers": [ 
        {
          "sysId": "b6fd058ee3db424ea374109299949b18",
          "user": {
            "name": "USERC",
            "value": "userc"
          }
        } 
     ],
     "groupRoles": [ 
        {
           "role": {
              "description": "The report administrator role.",
              "value": "ops_report_admin"
           },
           "sysId": "4112408600e947b89d051d36bf9cf6b3"
        } 
     ],
     "manager": null,
     "name": "test1",
     "navigationVisibility": [ "Reports" ],
     "parent": null,
     "permissions": [], 
     "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
   },
   {
     "ctrlNavigationVisibility": true,
     "description": "Description",
     "groupMembers": [], 
     "groupRoles": [ 
        {
           "role": {
              "description": "The report administrator role.",
              "value": "ops_report_admin"
           },
           "sysId": "4112408600e947b89d051d36bf9cf6b3"
        } 
     ],
     "manager": null,
     "name": "test2",
     "navigationVisibility": [ "Reports" ],
     "parent": null,
     "permissions": [ 
        {
           "allGroups": true,
           "commands": null,
           "defaultGroup": true,
           "nameWildcard": "*",
           "opCreate": true,
           "opDelete": true,
           "opExecute": false,
           "opRead": true,
           "opUpdate": true,
           "opswiseGroups": [],
           "permissionType": "Task",
           "sysId": "48eb7ec0c0a8026e0da9406feb022f4e"
        } 
      ],
      "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
   }
]


...


Description

URI

http://host_name/uc/resources/usergroup

HTTP Method

PUT

Description

Modifies the Group specified by the sysId in the request.
 
To modify Group properties without modifying related records, see the excludeRelated property, below.

Example URI

http://localhost:8080/uc/resources/usergroup

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create and Modify a Group: XML and JSON Examples.

Group Properties

See Group Properties.

Group Member Properties

See Group Member Properties.

Group Permission Properties

See Group Permission Properties.

Group Role Properties

See Group Role Properties.

Example Response

  • Status 200 /OK
    Successfully updated the user group with sysId <sysId>.

...


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

See Group Member Properties.

Response Group Permission Properties

See Group Permission Properties.

Response Group Role Properties

See Group Role Properties.

Anchor
Read a Group URI Parameters
Read a Group URI Parameters
Read a Group: URI Parameters

...

Anchor
Read a Group XML and JSON Examples
Read a Group XML and JSON Examples
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


Expand
titleXML
<userGroup retainSysIds="true">
  <ctrlNavigationVisibility>true</ctrlNavigationVisibility>
  <description>Description</description>
  <email>test@stonebranch.com</email>
  <groupMembers>
     <groupMember>
        <sysId>1fe28873315d4316ad8fec7c89477723</sysId>
        <user name="User C">userc</user>
     </groupMember>
     <groupMember>
        <sysId>361f995ad8f04a2ab39ee112e4a1301a</sysId>
        <user name="User B">userb</user>
     </groupMember>
  </groupMembers>
  <groupRoles>
     <groupRole>
	<role description="report admin role">ops_report_admin</role>
	<sysId>9c0d5e987a5847668c0182abf03c01e7</sysId>
     </groupRole>
  </groupRoles>
  <manager />
  <name>test</name>
  <navigationVisibility>
     <navigationNode>Reports</navigationNode>
  </navigationVisibility>
  <parent />
  <permissions>
     <permission>
	<allGroups>true</allGroups>
	<commands />
	<defaultGroup>true</defaultGroup>
	<nameWildcard>*</nameWildcard>
	<opCreate>true</opCreate>
	<opDelete>true</opDelete>
	<opExecute>false</opExecute>
	<opRead>true</opRead>
	<opUpdate>true</opUpdate>
	<opswiseGroups />
	<permissionType>Task</permissionType>
	<sysId>48eb7ec0c0a8026e0da9406feb022f4e</sysId>
     </permission>
		...
  </permissions>
  <sysId>920ef061ff4d498abe6e7ef883b1b5e1</sysId>
</userGroup>



Expand
titleJSON
{
  "ctrlNavigationVisibility": true,
  "description": "Description",
  "email": "test@stonebranch.com",
  "groupMembers": [ {
    "sysId": "b6fd058ee3db424ea374109299949b18",
    "user": {
      "name": "USERC",
      "value": "userc"
    }
  }, {
    "sysId": "c54e8898f3bb493e9f5ed7f030007e2e",
    "user": {
      "name": "USERB",
      "value": "userb"
    }
  } ],
  "groupRoles": [ {
    "role": {
      "description": "The report administrator role.",
      "value": "ops_report_admin"
    },
    "sysId": "4112408600e947b89d051d36bf9cf6b3"
  } ],
  "manager": null,
  "name": "test",
  "navigationVisibility": [ "Reports" ],
  "parent": null,
  "permissions": [ {
    "allGroups": true,
    "commands": null,
    "defaultGroup": true,
    "nameWildcard": "*",
    "opCreate": true,
    "opDelete": true,
    "opExecute": false,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Task",
    "sysId": "48eb7ec0c0a8026e0da9406feb022f4e"
  } ],
  "retainSysIds": true,
  "sysId": "920ef061ff4d498abe6e7ef883b1b5e1"
}


...

Property

UI Field Name

Description

Specifications

Required

Anchor
ctrlNavigationVisibility - GR
ctrlNavigationVisibility - GR
ctrlNavigationVisibility

Control Navigation Visibility

Indication of whether or not to control the visibility of navigation pane entries in the Controller Navigator, via the navigationVisibility property, for members of this Group. If ctrlNavigationVisibility is false, all entries are visible.

Boolean. Valid values: true/false. Default is false.

N

Anchor
description - GR
description - GR
description

Description

Description of the group.


N

Anchor
email - GR
email - GR
email

Email

Email address of this group.


N

Anchor
excludeRelated - GR
excludeRelated - GR
excludeRelated

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
titleNote

In XML, excludeRelated is specified as an attribute in the <userGroup> element.


Valid values: true/false (default is false).

N

Anchor
groupMembers - MEM
groupMembers - MEM
groupMembers

n/a

Users in this group.

Note
titleNote

Universal Controller only supports a user being a member of 1,000 groups or less.


Format:
XML


Panel
<groupMembers>
      <groupMember>
            <user>userc</user>
      </groupMember>
</groupMembers>


 
JSON


Panel
"groupMembers": [
  {
  "user":  "userc"
  }
]


N

Anchor
groupRoles - ROLE
groupRoles - ROLE
groupRoles

n/a

Roles assigned to this group.

Format:
XML


Panel
<groupRoles>
      <groupRole>
            <role>ops_report_admin</role>
      </groupRole>
</groupRoles>


 
JSON


Panel
"groupRoles": [
  {
  "role": "ops_report_global"
  }
]


N

Anchor
manager - GR
manager - GR
manager

Manager

ID of the Universal Controller user that is the manager of this group.


N

Anchor
name - GR
name - GR
name

Name

Name of the group.


Y

Anchor
navigationVisibility - GR
navigationVisibility - GR
navigationVisibility

Navigation Visibility

List of all Controller Navigator entries.

Format:
XML


Panel
<navigationVisibility>
      <navigationNode>Reports</navigationNode>
</navigationVisibility>


To include all values, set the navigationNode to All


Panel
<navigationVisibility>
      <navigationNode>All</navigationNode>
</navigationVisibility>


 
JSON


Panel
"navigationVisibility": [
  "Reports",
  "Support Portal"
]


 
Valid values: (see navigationNode Valid Values, below)

N

Anchor
parent - GR
parent - GR
parent

Parent

Name of this group's parent group, if any.


N

Anchor
permissions - PERM
permissions - PERM
permissions

n/a

Permissions assigned to this group.


N

Anchor
retainSysIds - GR
retainSysIds - GR
retainSysIds

n/a

For Create and Read web services; specification for whether or not the web service should persist the sysId property.


  • If retainSysIds is true and sysId is included in the request/response, sysId will be persisted to the database.
  • If retainSysIds is false and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller. |


Note
titleNote

In XML, retainSysIds is specified as an attribute in the <userGroup> element.


Valid values: true/false (default is true).

N

Anchor
sysId - GR
sysId - GR
sysId

n/a

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

...

Property

UI Field Name

Description

Specifications

Required

Anchor
allGroups - PERM
allGroups - PERM
allGroups

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

Anchor
commands - PERM
commands - PERM
commands

Commands

Commands that are associated with each permission.

Valid values: see Command Permissions, below.

N

Anchor
defaultGroup - PERM
defaultGroup - PERM
defaultGroup

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

Anchor
nameWildcard - PERM
nameWildcard - PERM
nameWildcard

Name

Specification to apply this permission to records whose name matches the string specified here.

Wildcards (*'s) can be used.

Y

Anchor
opCreate - PERM
opCreate - PERM
opCreate

Create

Allows members of the group to create records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
Cannot be set to true if permissionType is Agent or Task Instance.

N

Anchor
opDelete - PERM
opDelete - PERM
opDelete

Delete

Allows members of the group to delete records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
Cannot be set to true if permissionType is Agent.

N

Anchor
opExecute - PERM
opExecute - PERM
opExecute

Execute

Allows the user to execute records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
If the Strict Connection Execute Constraints Universal Controller system property is false:

  • opExecute can be set to true only if permissionType is Agent, Credential, Script, or Virtual Resource.

If the Strict Connection Execute Constraints Universal Controller system property is true:

  • opExecute can be set to true only if permissionType is Agent, Credential, Database Connection, Email Connection, SAP Connection, Script, SNMP Manager, or Virtual Resource.

N

Anchor
opRead - PERM
opRead - PERM
opRead

Read

Allows the user to read records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
If the Strict Business Service Membership Read Constraints Universal Controller system property is false:

  • opRead must be set to true if permissionType is Agent, Agent Cluster, Calendar, Credential, Database Connection, Email Connection, SAP Connection, Email Template, SNMP Manager, or Virtual Resource.


N

Anchor
opUpdate - PERM
opUpdate - PERM
opUpdate

Update

Allows members of the group to update records of the specified permissionType.

Boolean. Valid Values: true/false. Default is false.
 
Must be set to true if opCreate is set to true.

N

Anchor
opswiseGroups - PERM
opswiseGroups - PERM
opswiseGroups

Member of Business Services

Applies this permission to records that are members of the selected Business Service(s).

Format:
XML


Panel
<opswiseGroups>
  <opswiseGroup>test</opswiseGroup>
</opswiseGroups>


 
JSON


Panel
"opswiseGroups": ["test"]


N

Anchor
permissionType - PERM
permissionType - PERM
permissionType

Type

Type of permission for this group.

Valid values:

  • As String = Agent, As Value = 1
  • As String = Calendar, As Value = 2
  • As String = Credential, As Value = 3
  • As String = Task, As Value = 4
  • As String = Task Instance, As Value = 5
  • As String = Trigger, As Value = 6
  • As String = Application, As Value = 7
  • As String = Script, As Value = 8
  • As String = Variable, As Value = 9
  • As String = Virtual Resource, As Value = 10
  • As String = Agent Cluster, As Value = 11
  • As String = Email Template, As Value = 12
  • As String = Email Connection, As Value = 13
  • As String = Database Connection, As Value = 14
  • As String = SAP Connection, As Value = 15
  • As String = SNMP Manager, As Value = 16
  • As String = PeopleSoft Connection, As Value = 17
  • As String = Bundle, As Value = 18
  • As String = Promotion Target, As Value = 19
  • As String = OMS Server, As Value = 20

Y

Anchor
sysId - PERM
sysId - PERM
sysId

n/a

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

...