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