User Web Services
Overview
Universal Controller supports the following RESTful-based web services for User operations, which are listed alphabetically on this page.
- 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.
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), |
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. |
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 |
|
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 |
---|---|
|
|
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 |
|
Example Response |
|
Delete a User: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this user. |
String; URI parameter. |
Y (unless |
|
|
Name used within the Controller to identify this user. |
String; URI parameter. |
Y (unless |
|
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 http://localhost:9090/uc/resources/user/list?showTokens=true |
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Example |
|
User Properties |
See 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 |
List Users: XML and JSON Examples
XML |
JSON |
---|---|
|
|
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. |
Example URI |
http://localhost:8080/uc/resources/user |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example |
|
User Properties |
See User Properties. |
User Permission Properties |
|
User Role Properties |
See User Role Properties. |
Example Response |
|
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 |
|
Consumes Content-Type |
n/a |
Produces Content-Type |
application/xml, application/json |
User Properties |
See User Properties. |
User Permission Properties |
|
User Role Properties |
See User Role Properties. |
Example Response |
|
Read a User: URI Parameters
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 |
Properties
User Properties
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 |
Business phone number of this user. |
N |
|
|
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 |
Business department of this user. |
N |
|
|
Email address of this user. |
N |
||
|
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 In XML, |
Valid values: true/false (default is false). |
N |
|
First Name |
First Name of this user. |
N |
|
|
Allowed Impersonation Users |
Specifies the users that can be impersonated by this user using the X-Impersonate-User HTTP header on Web Service requests. User impersonation requires the ops_user_impersonate role. Users with the ops_admin role can impersonate any user and do not need to specify Allowed Impersonation Users. Format: <impersonate> <allowed>jane.doe</allowed> <allowed>john.doe</allowed> </impersonate> JSON "impersonate": [ "jane.doe", "john.doe" ] |
N | |
|
Last Name |
Last Name of this user. |
N |
|
|
Locked out |
Specification for whether or not the user is locked out of the Controller. |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Login Methods |
Login method(s) that the user can authenticate with. |
Valid Values:
|
N |
|
Manager |
Business manager of this user. |
Manager user ID |
N |
|
Middle Name |
Middle Name of this user. |
N |
|
|
Mobile Phone |
Mobile phone number of this user. |
N |
|
|
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 |
|
n/a |
Specification for whether or not the Create a User web service will persist the sysId property.
Note In XML, |
Valid values: true/false (default is true). |
N |
|
n/a |
System ID field in the database for this record. |
Persisted only if retainSysIds is set to true. |
N |
|
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 |
Business title of this user. |
N |
|
tokens |
Personal Access Tokens |
List of personal access tokens. If Format: <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 "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 | |
|
n/a |
Specifies whether the tokens will be displayed in the response. |
Boolean. Valid Values: true/false. Default is false. |
N |
|
User ID |
Log in ID for this user. |
Y |
|
|
Password |
Password of this user. |
Used only by the Create a User and Modify a User web services. |
Y |
|
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 |
User Permission Properties
Property |
UI Field Name |
Description |
Specifications |
Required |
---|---|---|---|---|
|
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 |
|
Commands |
Commands that are associated with each permission. |
Valid values: see #Command Permissions, below. |
N |
|
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 |
|
Name |
Specification to apply this permission to records whose name matches the string specified here. |
Wildcards (*'s) can be used. |
Y |
|
Create |
Allows the user to create records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Delete |
Allows the user to delete records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
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 |
|
Read |
Allows the user to read records of the specified |
Boolean. Valid Values: true/false. Default is false.
|
N |
|
Update |
Allows the user to update records of the specified |
Boolean. Valid Values: true/false. Default is false. |
N |
|
Member of Business Services |
Applies this permission to records that are members of the selected Business Service(s).
|
N |
|
|
Type |
Type of permission for this user. |
Valid values:
|
Y |
|
n/a |
System ID field in the database for a record. |
Persisted only if retainSysIds is set to true. |
N |
Command Permissions
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 |
|
User Role Properties
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 |
Create Personal Access Token
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 |
|
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 |
|
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 (Y if Web Service Personal Access Token Maximum Expiration In Days system property is specified.) |
Create Personal Access Token: XML and JSON Examples
XML |
JSON |
|
---|---|---|
Example Request |
|
|
Example Response |
|
|
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 |
|
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 |
|
|