Page Comparison

...

Panel

Table of Contents

maxlevel	2

...

XML

JSON

Expand

title	XML

<user retainSysIds="true">
   <active>true</active>
   <browserAccess>-- System Default --</browserAccess>
   <businessPhone />
   <commandLineAccess>-- System Default --</commandLineAccess>
   <department />
   <email>test@test.com</email>
   <firstName>Joe</firstName>
   <lastName>Doe</lastName>
   <lockedOut>false</lockedOut>
   <loginMethod>Standard, Single Sign-On</loginMethod>
   <manager>Administrator</manager>
   <middleName>M</middleName>
   <mobilePhone />
   <passwordNeedsReset>false</passwordNeedsReset>
   <permissions>
	<permission>
	   <allGroups>false</allGroups>
	   <commands>ALL</commands>
	   <defaultGroup>true</defaultGroup>
	   <nameWildcard>*</nameWildcard>
	   <opCreate>false</opCreate>
	   <opDelete>true</opDelete>
	   <opExecute>true</opExecute>
	   <opRead>true</opRead>
	   <opUpdate>true</opUpdate>
	   <opswiseGroups />
	   <permissionType>Agent</permissionType>
	   <sysId>c489750500d444eca9325559d0ef9673</sysId>
       </permission>
   </permissions>
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>
   <timeZone />
   <title>Vice President</title>
   <userName>test.user</userName>
   <userPassword>abc123</userPassword>
   <userRoles>
	<userRole>
	   <role description="The universal template admin role.">ops_universal_template_admin</role>
	   <sysId>187ecb3a27544b7fb702caee6dc8d5e3</sysId>
	</userRole>
	<userRole>
	   <role description="The report publishing role.">ops_report_publish</role>
	   <sysId>2e1dc86f47c6431884373f0e06b841da</sysId>
	</userRole>
   </userRoles>
   <webServiceAccess>-- System Default --</webServiceAccess>
</user>

Expand

title	JSON

{
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",
  "lastName": "Doe",
  "lockedOut": false,
  "loginMethod": Standard, Single Sign-On",
  "manager": "Administrator",
  "middleName": "M",
  "mobilePhone": null,
  "passwordNeedsReset": false,
  "permissions": [ {
    "allGroups": false,
    "commands": "ALL",
    "defaultGroup": true,
    "nameWildcard": "*",
    "opCreate": false,
    "opDelete": false,
    "opExecute": true,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Agent",
    "sysId": "c489750500d444eca9325559d0ef9673"
  } ],
  "retainSysIds": true,
  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca",
  "timeZone": null,
  "title": "Vice President",
  "userName": "test.user",
  "userPassword": "abc123",
  "userRoles": [ {
    "role": {
      "description": "The universal template admin role.",
      "value": "ops_universal_template_admin"
    },
    "sysId": "b8c25922d370438aada276cff669136d"
  }, {
    "role": {
      "description": "The report publishing role.",
      "value": "ops_report_publish"
    },
    "sysId": "fda36f00cc4544bc8f7fbd203290539a"
  } ],
  "webServiceAccess": "-- System Default --"
}

...

	Description
URI	http://host_name/uc/resources/user/list
HTTP Method	GET
Description	Retrieves information on all Users.
Example URI	http://localhost:8080/uc/resources/user/list http://localhost:9090/uc/resources/user/list?showTokens=true
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Users: XML and JSON Examples.
User Properties	See #User User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.

...

Name

Description

Specifications

Required

showTokens

Show personal access tokens.

Boolean

True - Includes the Token details
False (Default) - Empty Token List

N

...

XML

JSON

Expand

title	XML

<users>
  <user>
   <active>true</active>
   <browserAccess>-- System Default --</browserAccess>
   <businessPhone />
   <commandLineAccess>-- System Default --</commandLineAccess>
   <department />
   <email>test@test.com</email>
   <firstName>Joe</firstName>
   <lastName>Doe</lastName>
   <lockedOut>false</lockedOut>
   <loginMethod>Standard, Single Sign-On</loginMethod>
   <manager>Administrator</manager>
   <middleName>M</middleName>
   <mobilePhone />
   <passwordNeedsReset>false</passwordNeedsReset>
   <permissions />
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId>
   <timeZone />
   <title>Vice President</title>
   <userName>test.user</userName>
   <userPassword>abc123</userPassword>
   <userRoles />
   <webServiceAccess>-- System Default --</webServiceAccess>
  </user>
  <user> 
   <active>true</active> 
   <browserAccess>-- System Default --</browserAccess> 
   <businessPhone /> 
   <commandLineAccess>-- System Default --</commandLineAccess> 
   <department /> 
   <email>test@test.com</email> 
   <firstName>Joe</firstName> 
   <lastName>Doe</lastName> 
   <lockedOut>false</lockedOut> 
   <loginMethod>Standard, Single Sign-On</loginMethod> 
   <manager>Administrator</manager> 
   <middleName>M</middleName> 
   <mobilePhone /> 
   <passwordNeedsReset>false</passwordNeedsReset> 
   <permissions> 
    <permission> 
     <allGroups>false</allGroups> 
     <commands>ALL</commands> 
     <defaultGroup>true</defaultGroup> 
     <nameWildcard>*</nameWildcard> 
     <opCreate>false</opCreate> 
     <opDelete>true</opDelete> 
     <opExecute>true</opExecute> 
     <opRead>true</opRead> 
     <opUpdate>true</opUpdate> 
     <opswiseGroups /> 
     <permissionType>Agent</permissionType> 
     <sysId>c489750500d444eca9325559d0ef9673</sysId> 
    </permission>
  <permissions>
   <sysId>3de4c72e27c94d4aa840bffcbd7509ca</sysId> 
   <timeZone /> 
   <title>Vice President</title> 
   <userName>test.user</userName> 
   <userPassword>abc123</userPassword> 
   <userRoles /> 
   <webServiceAccess>-- System Default --</webServiceAccess> 
  </user>
</users>

Expand

title	JSON

[ {
  "active": true, 
  "browserAccess": "-- System Default --", 
  "businessPhone": null, 
  "commandLineAccess": "-- System Default --", 
  "department": null, 
  "email": "test@test.com", 
  "firstName": "Joe", 
  "lastName": "Doe", 
  "lockedOut": false, 
  "loginMethod": Standard, Single Sign-On", 
  "manager": "Administrator", 
  "middleName": "M", 
  "mobilePhone": null, 
  "passwordNeedsReset": false, 
  "permissions": [],
  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca", 
  "timeZone": null, 
  "title": "Vice President", 
  "userName": "test.user", 
  "userPassword": "abc123", 
  "userRoles": [],
  "webServiceAccess": "-- System Default --"
  },
  {
  "active": true,
  "browserAccess": "-- System Default --",
  "businessPhone": null,
  "commandLineAccess": "-- System Default --",
  "department": null,
  "email": "test@test.com",
  "firstName": "Joe",
  "lastName": "Doe",
  "lockedOut": false,
  "loginMethod": Standard, Single Sign-On",
  "manager": "Administrator",
  "middleName": "M",
  "mobilePhone": null,
  "passwordNeedsReset": false,
  "permissions": [ {
    "allGroups": false,
    "commands": "ALL",
    "defaultGroup": true,
    "nameWildcard": "*",
    "opCreate": false,
    "opDelete": false,
    "opExecute": true,
    "opRead": true,
    "opUpdate": true,
    "opswiseGroups": [],
    "permissionType": "Agent",
    "sysId": "c489750500d444eca9325559d0ef9673"
  } ],
  "retainSysIds": true,
  "sysId": "3de4c72e27c94d4aa840bffcbd7509ca",
  "timeZone": null,
  "title": "Vice President",
  "userName": "test.user",
  "userPassword": "abc123",
  "userRoles": [ {
    "role": {
      "description": "The universal template admin role.",
      "value": "ops_universal_template_admin"
    },
    "sysId": "b8c25922d370438aada276cff669136d"
  }, {
    "role": {
      "description": "The report publishing role.",
      "value": "ops_report_publish"
    },
    "sysId": "fda36f00cc4544bc8f7fbd203290539a"
  } ],
  "webServiceAccess": "-- System Default --"
  }
]

...

Name

Description

Specifications

Required

Mutually Exclusive With

userid

Unique ID for this User.

Y
(unless username
is specified)

username

Name used within the Controller to identify this User.

Maximum 40 alphanumerics.

Y
(unless userid
is specified)

userid

showTokens

Show personal access tokens.

Boolean

True - Includes the Token details
False (Default) - Empty Token List

N

...

Anchor
User Properties
User Properties
User Properties

Anchor

Property

UI Field Name

Description

Specifications

Required

Anchor

	active - USER
	active - USER

active

Active

Specification for whether or not the user is active. An active user can log in to the Controller. An inactive user cannot log in to the Controller, and the user will not appear in user lists.

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

N

Anchor

	browserAccess - USER
	browserAccess - USER

browserAccess

Web Browser Access

Specification for whether or not the user can log in to the user interface.

Valid Values:

As String = -- System Default --, As Value = 0
As String = Yes, As Value = 1
As String = No, As Value = 2

Default is – System Default – (0).

N

Anchor

	businessPhone - USER
	businessPhone - USER

businessPhone

Business Phone

Business phone number of this user.

N

Anchor

	commandLineAccess - USER
	commandLineAccess - USER

commandLineAccess

Command Line Access

Specification for whether or not the user can log in to the Universal Controller Command Line Interface (CLI).

Valid values:

As String = -- System Default --, As Value = 0
As String = Yes, As Value = 1
As String = No, As Value = 2

Default is – System Default – (0).

N

Anchor

	department - USER
	department - USER

department

Department

Business department of this user.

N

Anchor

	email - USER
	email - USER

email

Email

Email address of this user.

N

Anchor

	excludeRelated - USER
	excludeRelated - USER

excludeRelated

n/a

For the Modify User web service; specification for whether or not to exclude related records (User Permissions, User Roles) from the update, even if they are provided in the request.

Note

title	Note

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

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

N

Anchor

	firstName - USER
	firstName - USER

firstName

First Name

First Name of this user.

N

Anchor

	lastName - USER
	lastName - USER

lastName

Last Name

Last Name of this user.

N

Anchor

	lockedOut - USER
	lockedOut - USER

lockedOut

Locked out

Specification for whether or not the user is locked out of the Controller.

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

N

Anchor

	loginMethod - USER
	loginMethod - USER

loginMethod

Login Methods

Login method(s) that the user can authenticate with.

Valid Values:

N

Standard
Single Sign-On
Standard, Single Sign-On

N

Anchor

	manager - USER
	manager - USER

manager

Manager

Business manager of this user.

Manager user ID

N

Anchor

	middleName - USER
	middleName - USER

middleName

Middle Name

Middle Name of this user.

N

Anchor

	mobilePhone - USER
	mobilePhone - USER

mobilePhone

Mobile Phone

Mobile phone number of this user.

N

Anchor

	passwordNeedsReset - USER
	passwordNeedsReset - USER

passwordNeedsReset

Password Requires Reset

Specification for whether or not the user will be prompted to reset the password at next login.

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

N

Anchor

	retainSysIds - User
	retainSysIds - User

retainSysIds

n/a

Specification for whether or not the Create a User web service will persist the sysId property.

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

Note

title	Note

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

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

N

Anchor

	sysId - USER
	sysId - USER

sysId

n/a

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N

Anchor

	timeZone - USER
	timeZone - USER

timeZone

Time Zone

Time zone of this user.

When this user logs in, all scheduling times will be shown in the user's time zone, unless the trigger specifies a different time zone.

N

Anchor

	title - USER
	title - USER

title

Title

Business title of this user.

N

AnchoruserName - USERuserName - USERuserName

User ID

Log in ID for this user.

Y

AnchoruserPassword - USERuserPassword - USERuserPassword

Password

Password of this user.

If userPassword is included in the request, userPassword will be updated.

Used only by the Create a User and Modify a User web services.

Y
(for Create
a User)

AnchorwebServiceAccess - USERwebServiceAccess - USERwebServiceAccess

Web Service Access

Specification for whether or not the user can log in to the Universal Controller RESTful Web Services API.

Valid values:

Default is – System Default – (0).

N

...

Property

UI Field Name

Description

Specifications

Required

AnchorallGroups - PERMallGroups - PERMallGroups

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.

tokens

Personal Access Tokens

List of personal access tokens. If showTokens = true, these tokens will be displayed in the response.

Format:

XML

Panel

<tokens>

<token>

<createTime>2022-10-26 16:14:54 -0400</createTime>

<expiration>20221230</expiration>

<lastUsed>20221026</lastUsed>

<name>test1</name>

<userName>ops.admin</userName>

</token>

</tokens>

JSON

Panel

"tokens": [

{

"createTime": "2022-10-26 16:14:54 -0400",

"expiration": "20221230",

"lastUsed": "20221026",

"name": "test1",

"userName": "ops.admin"

},

{

"createTime": "2022-10-26 16:29:22 -0400",

"expiration": "Never",

"lastUsed": "Never",

"name": "test2",

"userName": "ops.admin"

}

],

N

showTokens

n/a

Specifies whether the tokens will be displayed in the response.

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

N

Anchor

commands

	userName -

PERM

USER

commands

	userName -

PERM

USER

commands

userName

Commands

Commands that are associated with each permission.

Valid values: see #Command Permissions, below.

N

AnchordefaultGroup - PERMdefaultGroup - PERMdefaultGroup

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

AnchornameWildcard - PERMnameWildcard - PERMnameWildcard

Name

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

Wildcards (*'s) can be used.

Y

AnchoropCreate - PERMopCreate - PERMopCreate

Create

Allows the user to create records of the specified permissionType.

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

Cannot be set to true if permissionType is Agent.

N

AnchoropDelete - PERMopDelete - PERMopDelete

Delete

Allows the user to delete records of the specified permissionType

User ID

Log in ID for this user.

Y

Anchor

	userPassword - USER
	userPassword - USER

userPassword

Password

Password of this user.

If userPassword is included in the request, userPassword will be updated.

Used only by the Create a User and Modify a User web services.

Y
(for Create
a User)

Anchor

	webServiceAccess - USER
	webServiceAccess - USER

webServiceAccess

Web Service Access

Specification for whether or not the user can log in to the Universal Controller RESTful Web Services API.

Valid values:

As String = -- System Default --, As Value = 0

As String = Yes, As Value = 1

As String = No, As Value = 2

Default is – System Default – (0).

N

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

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

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

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

opRead

JSON

permissionType

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

XML

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

	opExecute commands - PERMopExecute
	commands - PERM

opExecutecommands

Execute

Allows the user to execute records of the specified permissionType.

N

Anchor

opRead - PERM

Read

Allows the user to read records of the specified permissionTypeCommands

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.

If the Strict Business Service Membership Read Constraints Universal Controller system property is false:

N

Anchor

	opUpdate nameWildcard - PERMopUpdate
	nameWildcard - PERM

opUpdatenameWildcard

UpdateName

Allows the user to update 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 the user to create records of the specified permissionType.

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

Must Cannot be set to true if opCreate permissionType is set to trueAgent.

N

Panel

N

Anchor

permissionType - PERM

Type

Type of permission for this user.

Valid values:

Anchor

	opswiseGroups opDelete - PERMopswiseGroups
	opDelete - PERM

opswiseGroups

Member of Business Services

Panel

opDelete

Delete

Allows the user to delete records of the specified permissionType.

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

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 the user 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).

XML

Panel

Html bobswift
<pre> <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> </pre>

JSON

Panel

Html bobswift
<pre> "opswiseGroups": ["test"] </pre>

N

Anchor

	permissionType - PERM
	permissionType - PERM

permissionType

Type

Type of permission for this user.

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 a record.

Persisted only if retainSysIds is set to true.

N

...

	Description
URI	http://host_name/uc/resources/user/token
HTTP Method	POST
Description	Create the personal access token
Example URI	http://localhost:8080/uc/resources/user/token
Authentication	HTTP Basic
Produces Content-Type	text/plain
Consumes Content-Type	Application/XML, Application/JSON
Example Responses	Status 200 ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifX Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

Anchor
PAT Properties
PAT Properties
Create Personal Access Token: Payload Properties (XML, JSON)

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	userId
	userId

userId

N/A

UUID of the user

N

userName

Anchor

	userName
	userName

userName

N/A

User Name

String value of User name

N

userId

Anchor

	name
	name

name

Token Name

Specifies the name of the application that will access the Universal Controller Web Service APIs using the personal access token.

Y

Anchor

	expiration
	expiration

expiration

Expiration

Description of property.

Specifies when the personal access token expires. If left unspecified, the token never expires.

Valid Value: yyyy-mm-dd

N

Create Personal Access Token: XML and JSON Examples

...

	Description
URI	http://host_name/uc/resources/user/token/list
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user/token/list http://localhost:9090/uc/resources/user/token/list?username=test http://localhost:9090/uc/resources/user/token/list?userid=1234567
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful token list Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

List Personal Access Tokens: Query Parameters

The following request parameters can be used to filter the results of this service.

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
userid	N/A	UUID of the user	UUID of the user	N	username
username	N/A	User Name	String value of User name	N	userid

...

	Description
URI	http://host_name/uc/resources/user/token
HTTP Method	DELETE
Description	Delete the personal access token(s)
Example URI	http://localhost:9090/uc/resources/user/token?tokenname=test1&username=abc http://localhost:9090/uc/resources/user/token?tokenname=test1&userid=1234567
Authentication	HTTP Basic
Produces Content-Type
Consumes Content-Type
Example Responses	Status 200 Personal access token revoked successfully. Status 400 Error message. Status 403 Operation prohibited due to security constraints. Status 404 A user with name “{name}” does not exist. A user with id "{uuid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

...

Versions Compared

Old Version 22

New Version Current

Key

Anchor
User Properties
User Properties
User Properties

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

Anchor
PAT Properties
PAT Properties
Create Personal Access Token: Payload Properties (XML, JSON)

Create Personal Access Token: XML and JSON Examples

List Personal Access Tokens: Query Parameters

Page Comparison

Versions Compared

Old Version 22

New Version Current

Key

AnchorUser PropertiesUser PropertiesUser Properties

AnchorUser Permission PropertiesUser Permission PropertiesUser Permission Properties

AnchorPAT PropertiesPAT PropertiesCreate Personal Access Token: Payload Properties (XML, JSON)

Create Personal Access Token: XML and JSON Examples

List Personal Access Tokens: Query Parameters

Anchor
User Properties
User Properties
User Properties

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

Anchor
PAT Properties
PAT Properties
Create Personal Access Token: Payload Properties (XML, JSON)