A system user account. Two types of users are supported. Local user accounts may be viewed, created, updated, and deleted using this API. Enterprise user accounts are imported from an enterprise directory. They may be viewed using this API, but only by other enterprise users. Content-Type: application/vnd.plcm.plcm-user-v2+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| plcmServiceClassV2 | PlcmServiceClassV2 | See Definition of PlcmServiceClassV2 | |
| plcmUserRoleList | PlcmUserRoleList | See Definition of PlcmUserRoleList | |
| username | Username | The user's login name. Modification of this field is not allowed. A domain and username combination uniquely identifies a user. A colon that is not escaped by quote marks is not acceptable in username. | Mandatory |
| firstName | FirstName | The user's first name. Mandatory for local users, but optional for enterprise users. | |
| lastName | LastName | The user's last name. Mandatory for local users, but optional for enterprise users. | |
| domain | Domain | The domain associated with the user. All users added manually to the system are in the LOCAL domain. Modification of this field is not allowed. | |
| emailAddress | EmailAddress | The email address of the user. | |
| tenant | Tenant | A UUID that identifies the area to which this user belongs. | |
| title | Title | The title of the user. | |
| department | Department | The department of the user. | |
| city | City | The city of the user. | |
| phoneNumber | PhoneNumber | The phone number of the user. | |
| password | Password | The local user's system login password (not conference or chairperson passcode). The password must satisfy the local password rules specified for the system. | |
| disabled | boolean | Disabled users do not have conferencing privileges and cannot log into the UI or API. | |
| locked | boolean | Locked users have been locked out by the system due to failed login attempts. An administrator can unlock the account by setting this field, but cannot lock it. | |
| passwordChangeRequired | boolean | User must change password to obtain authorization. | |
| passback | Passback | User defined value for that is opaque to the system. | |
| passthru | Passthru | User defined value that that is opaque to the system. Note: this value is available after the call and/or conference is terminated in the userDataA field in the call and/or conference CDR. | |
| uuid | string | ||
| originalPassword | OriginalPassword | The local user's system original login password which is required if you are changing the password of the same user that is posting the call. | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| OriginalPassword | string | Length of value must be >=1 Length of value must be <=128 |
| Passthru | string | Length of value must be >=1 Length of value must be <=512 |
| Passback | string | Length of value must be >=1 Length of value must be <=512 |
| Password | string | Length of value must be >=1 Length of value must be <=128 |
| PhoneNumber | string | Length of value must be >=1 Length of value must be <=24 |
| City | string | Length of value must be >=1 Length of value must be <=64 |
| Department | string | Length of value must be >=1 Length of value must be <=64 |
| Title | string | Length of value must be >=1 Length of value must be <=64 |
| Tenant | base64Binary | Length of value must be >=16 Length of value must be <=16 |
| EmailAddress | string | Length of value must be >=1 Length of value must be <=512 |
| Domain | string | Length of value must be >=1 |
| LastName | string | Length of value must be >=1 Length of value must be <=256 |
| FirstName | string | Length of value must be >=1 Length of value must be <=256 |
| Username | string | Length of value must be >=1 Length of value must be <=256 |