Panel | ||||
---|---|---|---|---|
|
...
- Create a User
- Delete a User
- List Users
- Modify a User
- Read a User
- Create Personal Access Token
- List Personal Access Tokens
- Revoke a Personal Access Token
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
List Users: URI Parameters
Name | Description | Specifications | Required |
---|---|---|---|
| Show tokens. | Boolean
| N |
Anchor | ||||
---|---|---|---|---|
|
...
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 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
| 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commandLineAccess
| Locked out | 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)is locked out of the Controller. | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
department loginMethod | Department | Business department of this user.Login Methods | Login method(s) that the user can authenticate with. | Valid Values: | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
email manager | EmailManager | Email address Business manager of this user. | Manager user ID | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
excludeRelated | n/a |
Note | ||
---|---|---|
| ||
In XML, |
Valid values: true/false (default is false).
middleName
Middle Name
Middle Name of this user.
N
Anchor | ||||
---|---|---|---|---|
|
firstName
mobilePhone
First Name
First Name Mobile Phone
Mobile phone number of this user.
N
lockedOut
Locked out
Anchor | ||||
---|---|---|---|---|
|
lastName
Last Name
Last Name of this user.
N
passwordNeedsReset
Password Requires Reset
Specification for whether or not the user is locked out of the Controllerwill be prompted to reset the password at next login.
Boolean. Valid Values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
loginMethod
Login Methods
Login method(s) that the user can authenticate with.
Valid Values:retainSysIds
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
Anchor | ||||
---|---|---|---|---|
|
manager
sysId
Manager
Business manager of this user.
Manager user IDn/a
System ID field in the database for this record.
Persisted only if retainSysIds is set to true.
N
Anchor | ||||
---|---|---|---|---|
|
middleName
timeZone
Middle Name
Middle Name Time Zone
Time zone of this user.
N
mobilePhone
Mobile Phone
Mobile phone number 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
Title
Business title of this user.
N
Property
UI Field Name
Description
Specifications
Required
allGroups
Member of Any Business Service or Unassigned
Anchor | ||||
---|---|---|---|---|
|
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.
Note | ||
---|---|---|
| ||
In XML, |
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
...
| 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 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 | ||||||||||||||||||||||||||||||||
commands | Commands | Commands that are associated with each permission. | Valid values: see #Command Permissions, below. | N | ||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||
nameWildcard | Name | Specification to apply this permission to records whose name matches the string specified here. | Wildcards (*'s) can be used. | Y | ||||||||||||||||||||||||||||||||
opCreate | Create | Allows the user to create records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||
opDelete | Delete | Allows the user to delete records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||
commands opExecute | Commands | Commands that are associated with each permission. | Valid values: see #Command Permissions, below. | N | ||||||||||||||||||||||||||||||||
Anchor | defaultGroup - PERM | defaultGroup - PERM | Unassigned to Business Service | Specification for whether or not this permission applies to records that do not belong to any Business ServiceExecute | Allows the user to execute records of the specified | Boolean. Valid Values: true/false. Default is false. | N | |||||||||||||||||||||||||||||
Anchor | nameWildcard - PERM | nameWildcard - PERM | 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 | N | |||||||||||||||||||||||||
opRead | Read | Allows the user to create read records of the specified | Boolean. Valid Values: true/false. Default is false. permissionType is Agent.If the Strict Business Service Membership Read Constraints Universal Controller system property is false: | N | ||||||||||||||||||||||||||||||||
opDelete opUpdate | DeleteUpdate | Allows the user to delete update records of the specified | Boolean. Valid Values: true/false. Default is false. | N | Anchor | | 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: | Member of Business Services | Applies this permission to records that are members of the selected Business Service(s).
| N | ||||||||||||||||||||||||||||||
opRead permissionType | Read | Allows the user to read records of the specified | N | |||||||||||||||||||||||||||||||||
Anchor | opUpdate - PERM | opUpdate - PERM | Update | Allows the user to update records of the specified | Boolean. Valid Values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||
Anchor | opswiseGroups - PERM | opswiseGroups - PERM | Member of Business Services | |||||||||||||||||||||||||||||||||
Panel | ||||||||||||||||||||||||||||||||||||
Panel | N | |||||||||||||||||||||||||||||||||||
Anchor | permissionType - PERM | permissionType - PERM | Type | Type of permission for this user. | Y | |||||||||||||||||||||||||||||||
Anchor | sysId - PERM | sysId - PERM | n/a | System ID field in the database for a record. | Persisted only if retainSysIds is set to true. | N |
...
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 | 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 | ||||
---|---|---|---|---|
|
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 | ||||||
| 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
| ||||||||||
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 |