Panel

Table of Contents

maxlevel	2

Anchor
Overview
Overview
Overview

Universal Controller supports the following RESTful-based web services for User operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Permissions

The following table identifies the web service operations that a user can perform

Operation	User without any role	User with ops_service_role	User with ops_user_admin or ops_admin role
Read	Read its own record (details). Read its own Role, Permissions, and Member of Groups (group membership), but cannot read any Group record.	Read any user record.	Create/update/read/delete any fields or any related data.
Update	Update a subset of fields of its own record. Cannot update any related data.	Update a subset of fields of its own record. Cannot update any related data.
Create	No permission to create a user.	No permission to create a user.
Delete	No permission to delete a user.	No permission to delete a user.

Anchor
Create a User
Create a User
Create a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method
Description	Creates a new User.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples: XML and JSON Examples, below.
User Properties	See User Properties, below.
User Permission Properties	See User Permission Properties, below.
User Role Properties	See User Role Properties, below.
Example Response	Status 200 /OK Successfully created the user with sysId {sysId}.

Anchor
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User: XML and JSON Examples

The excludeRelated and retainSysIds properties are specified as attributes in the <user> element of XML web services.

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 --"
}

Anchor
Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

	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.

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

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
`name`	Token Name	Token Name	Specifies the name of the application that will access the Universal Controller Web Service APIs using the personal access token.	Y
`expiration`	Expiration	Description of property.	Specifies when the personal access token expires. If left unspecified, the token never expires.	N

Create Personal Access Token: XML and JSON Examples

XML

JSON

Example Request

Expand

title	XML

 <token>
        <expiration>2022-07-30</expiration>
        <name>test1</name>
        <userId></userId>
        <userName>sha</userName>
    </token>

Expand

title	JSON

{
        "expiration": "2022-07-30",
        "name": "test1",
        "userName": "ops.admin",
        "userId": ""
    }

Example Response

Expand

title	XML

ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP

Expand

title	JSON

ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP

Anchor
Delete a User
Delete a User
Delete a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	DELETE
Description	Deletes a User.
URI Parameters	See Delete a User URI Parameters, below.
Example URI	http://localhost:8080/uc/resourcess/user?username=Test_User_Name http://localhost:9080/uc/resources/user?userid=18fcf558002743e38edc49114734b6d9
Example Response	Status 200 /OK User {username} deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify userid and username at the same time. Status 404 /Not Found User with {username/userid} does not exist.

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`userid`	ID used within the Controller to identify this user.	String; URI parameter.	Y (unless `userename` is specified)	`username`
`username`	Name used within the Controller to identify this user.	String; URI parameter.	Y (unless `userid` is specified)	`userid`

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

	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 will be needed for the service.

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

List Personal Access Tokens: XML and JSON Examples

XML

JSON

Example Response

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tokens>
    <token>
        <createTime>2022-07-28 17:11:35 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test2</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-29 12:39:20 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test3</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-28 17:08:07 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test4</name>
        <userName>ops.admin</userName>
    </token>
    <token>
        <createTime>2022-07-29 12:56:33 -0400</createTime>
        <expiration>20220730</expiration>
        <lastUsed>Never</lastUsed>
        <name>test5</name>
        <userName>ops.admin</userName>
    </token>
</tokens>

Expand

title	JSON

[
    {
        "createTime": "2022-07-28 17:11:35 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test2",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-29 12:39:20 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test3",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-28 17:08:07 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test4",
        "userName": "ops.admin"
    },
    {
        "createTime": "2022-07-29 12:56:33 -0400",
        "expiration": "20220730",
        "lastUsed": "Never",
        "name": "test5",
        "userName": "ops.admin"
    }
]

Anchor
List Users
List Users
List Users

	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
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Users: XML and JSON Examples.
User Properties	See #User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.

Optionally Include Personal Access Tokens on User Payloads: List User API

The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.

	Description
URI	http://host_name/uc/resources/user/list
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user/list?username=test&showTokens=true http://localhost:9090/uc/resources/user/list?userid=1234567&showTokens=false
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful user details 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.

Optinally Include Personal Access Tokens on List User Payloads: Query Parameters

The following request parameters will be needed for the service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

Y

username

N/A

User Name

String value of User name

Y

userid

showTokens

N/A

Show tokens

Boolean

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

N

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

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 --"
  }
]

Anchor
Modify a User
Modify a User
Modify a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	PUT
Description	Modifies the User specified by the sysId in the request. To modify User properties without modifying related records, see the excludeRelated property.
Example URI	http://localhost:8080/uc/resources/user
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example	See Create, Modify, and Read a User: XML and JSON Examples.
User Properties	See User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.
Example Response	Status 200 /OK Successfully updated the user with sysId <sysId>.

Anchor
Read a User
Read a User
Read a User

	Description
URI	http://host_name/uc/resources/user
HTTP Method	GET
Description	Retrieves information on a specific User.
URI Parameters	See Read a User: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/user?username=test.user http://localhost:8080/uc/resources/user?userid=c489750500d444eca9325559d0ef9673
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
User Properties	See User Properties.
User Permission Properties	See User Permission Properties.
User Role Properties	See User Role Properties.
Example Response	Status 200 /OK (See Create, Modify, and Read a User: XML and JSON Examples.) Status 404 /Not Found A user with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Anchor
Read a User URI Parameters
Read a User URI Parameters
Read a User: URI Parameters

Name	Description	Specifications	Required	Mutually Exclusive With
`userid`	Unique ID for this User.		Y (unless `username` is specified)	`username`
`username`	Name used within the Controller to identify this User.	Maximum 40 alphanumerics.	Y (unless `userid` is specified)	`userid`

Optionally Include Personal Access Tokens on User Payloads: Read User API

The User Read and List API’s optionally allows to display the tokens using the query parameter. The default value is false and user has to pass the parameter to view the token details.

	Description
URI	http://host_name/uc/resources/user
HTTP Method	GET
Description	List the user tokens
Example URI	http://localhost:9090/uc/resources/user?username=test&showTokens=true http://localhost:9090/uc/resources/user?userid=1234567&showTokens=false
Authentication	HTTP Basic
Produces Content-Type	Application/XML, Application/JSON
Consumes Content-Type
Example Responses	Status 200 Successful user details 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.

Optinally Include Personal Access Tokens on Read a User Payloads: Query Parameters

The following request parameters will be needed for the service.

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

userid

N/A

UUID of the user

Y

username

N/A

User Name

String value of User name

Y

userid

showTokens

N/A

Show tokens

Boolean

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

N

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

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

Revoke Personal Access Token: Query Parameters

The following request parameters will be needed for the service.

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
userid	N/A	UUID of the user	UUID of the user	Y	username
username	N/A	User Name	String value of User name	N	userid
tokenname	token 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
Properties
Properties
Properties

Anchor
User Properties
User Properties
User Properties

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:

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:

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

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.

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

Anchor

	userName - USER
	userName - USER

userName

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:

Default is – System Default – (0).

N

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

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 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

Anchor

	opDelete - PERM
	opDelete - PERM

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:

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

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:

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

JSON

Panel

N

Anchor

	permissionType - PERM
	permissionType - PERM

permissionType

Type

Type of permission for this user.

Valid values:

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

Anchor
Command Permissions
Command Permissions
Command Permissions

Permission Type	Commands
Agent	ALL resume_agent suspend_agent
Agent Cluster	ALL resolve_agent_cluster resume_agent_cluster suspend_agent_cluster resume_agent_cluster_membership suspend_agent_cluster_membership
Application	ALL appl_start appl_stop appl_query
Bundle	ALL promote_bundle
Calendar	ALL copy_calendar
Credential
Database Connection	ALL copy_database_connection database_connection_test
Email Connection	ALL copy_email_connection email_connection_test
Email Template	ALL copy_email_template
OMS Server	ALL resume_oms_server suspend_oms_server
PeopleSoft Connection	ALL copy_peoplesoft_connection
Promotion Target	ALL refresh_target_agents
SAP Connection	ALL copy_sap_connection
Script	ALL copy_script
SNMP Manager	ALL copy_snmp_manager
Task	ALL copy_task launch recalculate_forecast reset_statistics reset_zos_override_statistics set_execution_restriction
Task Instance	ALL cancel clear_all_dependencies clear_exclusive clear_resources clear_timewait force_finish force_finish_cancel hold insert_task rerun release release_recursive retrieve_output set_edge_satisfied (Mark as Satisfied in UI) set_edges_satisfied (Clear Predecessors in UI) set_priority_low set_priority_medium set_priority_high set_manual_completed set_manual_started skip unskip
Trigger	ALL assign_trigger_execution_user copy_trigger disable_trigger enable_trigger recalculate_forecast set_skip_count trigger_now
Variable
Virtual Resource	ALL copy_virtual_resource

Anchor
User Role Properties
User Role Properties
User Role Properties

Property

UI Field Name

Description

Specifications

Required

Anchor

	role - ROLE
	role - ROLE

role

n/a

Role assigned to this user.

N

Anchor

	sysId - ROLE
	sysId - ROLE

sysId

n/a

System ID field in the database for a record.

N

Versions Compared

Old Version 4

New Version 5

Key

Anchor
Overview
Overview
Overview

Permissions

Anchor
Create a User
Create a User
Create a User

Anchor
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User: XML and JSON Examples

Anchor
Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

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

Create Personal Access Token: XML and JSON Examples

Anchor
Delete a User
Delete a User
Delete a User

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

List Personal Access Tokens: Query Parameters

List Personal Access Tokens: XML and JSON Examples

Anchor
List Users
List Users
List Users

Optionally Include Personal Access Tokens on User Payloads: List User API

Optinally Include Personal Access Tokens on List User Payloads: Query Parameters

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

Anchor
Modify a User
Modify a User
Modify a User

Anchor
Read a User
Read a User
Read a User

Anchor
Read a User URI Parameters
Read a User URI Parameters
Read a User: URI Parameters

Optionally Include Personal Access Tokens on User Payloads: Read User API

Optinally Include Personal Access Tokens on Read a User Payloads: Query Parameters

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

Revoke Personal Access Token: Query Parameters

Anchor
Properties
Properties
Properties

Anchor
User Properties
User Properties
User Properties

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

Anchor
Command Permissions
Command Permissions
Command Permissions

Anchor
User Role Properties
User Role Properties
User Role Properties

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

AnchorOverviewOverviewOverview

Permissions

AnchorCreate a UserCreate a UserCreate a User

AnchorCreate, Modify, and Read a User XML and JSON ExamplesCreate, Modify, and Read a User XML and JSON ExamplesCreate, Modify, and Read a User: XML and JSON Examples

AnchorCreate Personal Access TokenCreate Personal Access TokenCreate Personal Access Token

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

Create Personal Access Token: XML and JSON Examples

AnchorDelete a UserDelete a UserDelete a User

AnchorDelete a User URI ParametersDelete a User URI ParametersDelete a User: URI Parameters

AnchorList Personal Access TokensList Personal Access TokensList Personal Access Tokens

List Personal Access Tokens: Query Parameters

List Personal Access Tokens: XML and JSON Examples

AnchorList UsersList UsersList Users

Optionally Include Personal Access Tokens on User Payloads: List User API

Optinally Include Personal Access Tokens on List User Payloads: Query Parameters

AnchorList Users XML and JSON ExamplesList Users XML and JSON ExamplesList Users: XML and JSON Examples

AnchorModify a UserModify a UserModify a User

AnchorRead a UserRead a UserRead a User

AnchorRead a User URI ParametersRead a User URI ParametersRead a User: URI Parameters

Optionally Include Personal Access Tokens on User Payloads: Read User API

Optinally Include Personal Access Tokens on Read a User Payloads: Query Parameters

AnchorRevoke Personal Access TokenRevoke Personal Access TokenRevoke Personal Access Token

Revoke Personal Access Token: Query Parameters

AnchorPropertiesPropertiesProperties

AnchorUser PropertiesUser PropertiesUser Properties

AnchorUser Permission PropertiesUser Permission PropertiesUser Permission Properties

Anchor Command Permissions Command PermissionsCommand Permissions

AnchorUser Role PropertiesUser Role PropertiesUser Role Properties

Anchor
Overview
Overview
Overview

Anchor
Create a User
Create a User
Create a User

Anchor
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User XML and JSON Examples
Create, Modify, and Read a User: XML and JSON Examples

Anchor
Create Personal Access Token
Create Personal Access Token
Create Personal Access Token

Anchor
Delete a User
Delete a User
Delete a User

Anchor
Delete a User URI Parameters
Delete a User URI Parameters
Delete a User: URI Parameters

Anchor
List Personal Access Tokens
List Personal Access Tokens
List Personal Access Tokens

Anchor
List Users
List Users
List Users

Anchor
List Users XML and JSON Examples
List Users XML and JSON Examples
List Users: XML and JSON Examples

Anchor
Modify a User
Modify a User
Modify a User

Anchor
Read a User
Read a User
Read a User

Anchor
Read a User URI Parameters
Read a User URI Parameters
Read a User: URI Parameters

Anchor
Revoke Personal Access Token
Revoke Personal Access Token
Revoke Personal Access Token

Anchor
Properties
Properties
Properties

Anchor
User Properties
User Properties
User Properties

Anchor
User Permission Properties
User Permission Properties
User Permission Properties

Anchor
Command Permissions
Command Permissions
Command Permissions

Anchor
User Role Properties
User Role Properties
User Role Properties