...
...
...
...
...
...
Panel | ||||
---|---|---|---|---|
|
...
- Create a User
- Delete a User
- List Users
- Modify a User
- Read a User
- Create Personal Access Token
- List Personal Access Tokens
- Revoke Personal Access Token
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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 | |
User Properties | |
User Permission Properties | |
User Role Properties | See User Role Properties. |
List Users: URI Parameters
Name | Description | Specifications | Required |
---|---|---|---|
| Show personal access tokens. | Boolean
| N |
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | |||||
---|---|---|---|---|---|---|
|
...
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this User. | Y |
| |
| Name used within the Controller to identify this User. | Maximum 40 alphanumerics. | Y |
|
| Show personal access tokens. | Boolean
| N |
Anchor |
---|
...
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.
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
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
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
...
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
...
Business Phone
...
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||
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 | ||||||
businessPhone | Business Phone | Business phone number of this user. | N | |||||||
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 | ||||||
department | Department | Business department of this user. | N | |||||||
email | Email address of this user. | N | ||||||||
|
|
|
commandLineAccess
Command Line Access
| n/a | For the Modify User web service; specification for whether or not |
Valid values:
Default is – System Default – (0to exclude related records (User Permissions, User Roles) from the update, even if they are provided in the request.
| Valid values: true/false (default is false). | N | |||||
|
|
|
department
Business department
|
Department
First Name | First Name of this user. | N | |
|
|
|
email
Email address
|
Last Name | Last Name of this user. | N | |
|
|
|
excludeRelated
n/a
| Locked out | Specification for whether or not |
Note | ||
---|---|---|
| ||
In XML, |
the user is locked out of the Controller. | Boolean. Valid Values: true/false |
. Default is false |
. | N |
|
|
|
firstName
|
First Name
First Name of this user.
N
lastName
Last Name
Last Name of this user.
N
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
loginMethod
Login Methods
Login method(s) that the user can authenticate with.
Valid Values:
N
Login Methods | Login method(s) that the user can authenticate with. | Valid Values:
| N | ||||||||||||
manager | Manager | Business manager of this user. | Manager user ID | N | |||||||||||
middleName | Middle Name | Middle Name of this user. | N | ||||||||||||
mobilePhone | Mobile Phone | Mobile phone number of this user. | N | ||||||||||||
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 | |||||||||||
retainSysIds | n/a | Specification for whether or not the Create a User web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||
sysId | n/a | System ID field in the database for this record. | Persisted only if retainSysIds is set to true. | N | |||||||||||
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 | |||||||||||
title | Title | Business title of this user. | N |
userName
User ID
Log in ID for this user.
Y
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)
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
...
Property
UI Field Name
Description
Specifications
Required
allGroups
Member of Any Business Service or Unassigned
tokens | Personal Access Tokens | List of personal access tokens. If Format:
JSON
| N | |||||
| n/a | Specifies whether the tokens will be displayed in the response. | Boolean. Valid Values: true/false. Default is false. | N | ||||
|
|
|
|
|
commands
defaultGroup
Unassigned to Business Service
|
Commands
Commands that are associated with each permission.
Valid values: see #Command Permissions, below.
N
User ID | Log in ID for this user. | Y | ||||||||
userPassword | Password | Password of this user. | Used only by the Create a User and Modify a User web services. | Y | ||||||
webServiceAccess | Web Service Access | Specification for whether or not |
Boolean. Valid Values: true/false. Default is false.
N
nameWildcard
Name
Specification to apply this permission to records whose name matches the string specified here.
Wildcards (*'s) can be used.
Y
opCreate
Create
permissionType
the user can log in to the Universal Controller RESTful Web Services API. | Valid values:
Default is – System Default – (0). | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | ||||||||||||||||||||||||||
opDelete commands | Delete | Allows the user to delete records of the specified | Boolean. Valid Values: true/false. Default is falseCommands | Commands that are associated with each permission. | Valid values: see #Command Permissions, below. | N | ||||||||||||||||||||||||
Allows the user to execute records of the specified permissionType
opExecute | Execute |
| 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 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 |
Anchor | ||||
---|---|---|---|---|
|
nameWildcard
Name
Specification to apply this permission to records whose name matches the string specified here.
Wildcards (*'s) can be used.
Y
Anchor | ||||
---|---|---|---|---|
|
opCreate
Create
Allows the user to read 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 | ||||
---|---|---|---|---|
|
opUpdate
opDelete
UpdateDelete
Allows the user to update delete 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
opswiseGroups
Member of Business Services
Applies this permission to records that are members of the selected Business Service(s).
XML
JSON
N
permissionType
Type
Type of permission for this user.
Valid values:
Y
sysId
n/a
System ID field in the database for a record.
Persisted only if retainSysIds is set to true.
N
...
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
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
n/a
...
Role assigned to this user.
...
N
...
n/a
...
System ID field in the database for a record.
...
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.
Create Personal Access Token: Payload Properties (XML, JSON)
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
N/A
...
UUID of the user
...
UUID of the user
...
N
...
userName
...
N/A
...
User Name
...
String value of User name
...
N
...
userId
...
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
...
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
...
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
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
...
N | ||||||||||||||||||
opExecute | Execute | Allows the user to execute records of the specified | Boolean. Valid Values: true/false. Default is false.
If the Strict Connection Execute Constraints Universal Controller system property is true:
| N | ||||||||||||||
opRead | Read | Allows the user to read records of the specified | Boolean. Valid Values: true/false. Default is false.
| N | ||||||||||||||
opUpdate | Update | Allows the user to update records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||
opswiseGroups | Member of Business Services | Applies this permission to records that are members of the selected Business Service(s).
| N | |||||||||||||||
permissionType | Type | Type of permission for this user. | Valid values:
| Y | ||||||||||||||
sysId | n/a | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N |
Anchor | ||||
---|---|---|---|---|
|
Permission Type | Commands |
---|---|
Agent |
|
Agent Cluster |
|
Application |
|
Bundle |
|
Calendar |
|
Credential | |
Database Connection |
|
Email Connection |
|
Email Template |
|
OMS Server |
|
PeopleSoft Connection |
|
Promotion Target |
|
SAP Connection |
|
Script |
|
SNMP Manager |
|
Task |
|
Task Instance |
|
Trigger |
|
Variable | |
Virtual Resource |
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
role | n/a | Role assigned to this user. | N | |||||||
sysId | n/a | System ID field in the database for a record. | N |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/user/token |
HTTP Method | POST |
Description | Create the personal access token |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | text/plain |
Consumes Content-Type | Application/XML, Application/JSON |
Example Responses |
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| N/A | UUID of the user | UUID of the user | N | userName | ||||||
| N/A | User Name | String value of User name | N | userId | ||||||
| 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 | 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
XML | JSON | |
---|---|---|
Example |
Request |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
title | JSON |
---|
| ||||||||||||
Example Response |
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
|
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 |
List Personal Access Tokens: XML and JSON Examples
XML | JSON | |||||
---|---|---|---|---|---|---|
Example Response |
|
|
|
|
|
|
|
|
|
...
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
showTokens
Show tokens.
Boolean
True - Includes the Token details
False (Default) - Empty Token List
|
|
Anchor | ||||
---|---|---|---|---|
|
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 |
|
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 |