Versions Compared

Key

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


Panel
Table of Contents
maxlevel2

...

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.

...


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 19169287 User Properties, below.

User Permission Properties

See 19169287 User Permission Properties, below.

User Role Properties

See 19169287 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
titleXML
<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
titleJSON
{
  "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

HTTP Method

DELETE

Description

Deletes a User.

URI Parameters

See 19169287 Delete a User URI Parameters, below.

Example URI

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.

...


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 19169287 User Properties.

User Permission Properties

See 19169287 User Permission Properties.

User Role Properties

See 19169287 User Role Properties.

List Users: URI Parameters 

...

XML

JSON


Expand
titleXML
<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
titleJSON
[ {
"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 --" }
]


...


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 19169287 User Properties.

User Permission Properties

See 19169287 User Permission Properties.

User Role Properties

See 19169287 User Role Properties.

Example Response

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

...


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

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

User Properties

See 19169287 User Properties.

User Permission Properties

See 19169287 User Permission Properties.

User Role Properties

See 19169287 User Role Properties.

Example Response

...

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
titleNote

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:

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

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

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


  • 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

...

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:


  • 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>
&lt;opswiseGroups&gt;
  &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt;
&lt;/opswiseGroups&gt;
</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

...


XML

JSON

Example Request


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


Example Response


Expand
titleXML
ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP



Expand
titleJSON
ucp_taUFeDdhrlpn8Gc5Vu9IO2LRQ29pbvBRJUSPvifP


...

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

...


XML

JSON

Example Response


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



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


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

...