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-v4+xml. All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | List of link | See Definition of link | |
| plcm-service-class-v2 | plcm-service-class-v2 | See Definition of plcm-service-class-v2 | |
| plcm-user-group-role-list | plcm-user-group-role-list | See Definition of plcm-user-group-role-list | |
| plcm-user-role-list | plcm-user-role-list | See Definition of plcm-user-role-list | |
| 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 |
| first-name | FirstName | The user's first name. Mandatory for local users, but optional for enterprise users. | |
| last-name | 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. | |
| email-address | 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. | |
| phone-number | 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 | xs:boolean | Disabled users do not have conferencing privileges and cannot log into the UI or API. | |
| locked | xs: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. | |
| password-change-required | xs:boolean | User must change password to obtain authorization. | |
| groups | List of xs:string | group membership UUIDs | |
| 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 | xs:string | ||
| entity-tag | 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. | |
| chairperson-passcode | ChairpersonPasscode | The local user's chairperson passcode. | |
| conference-passcode | ConferencePasscode | The local user's conference passcode. | |
| override-chairperson-passcode | xs:boolean | Override local user's chairperson passcode. | |
| override-conference-passcode | xs:boolean | Override local user's conference passcode. | |
| enterprise-chairperson-passcode | xs:string | The enterprise user's chairperson passcode. This field is read-only. | |
| enterprise-conference-passcode | xs:string | The enterprise user's conference passcode. This field is read-only. | |
| territory-name | xs:string | Territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned. | |
| svc-only-territory-name | xs:string | SVC-Only territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned. | |
| conference-room | List of ConferenceRoom | ||
| override-default-territory-name | xs:boolean | When true, territory-name must be specified in the request. When false, territory-name value will be determined by the system default. | |
| override-default-svc-only-territory-name | xs:boolean | When true, svc-only territory-name must be specified in the request. When false, svc-only territory-name value will be determined by the system default. | |
| override-default-service-class | xs:boolean | When true, plcm-service-class-v2 must be specified in the request. When false, plcm-service-class-v2 value will be determined by the system default. | |
| original-password | 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. |
| Name | Type | Description | Attributes |
|---|---|---|---|
| conference-room-identifier | xs:string | Read-only identifier of a conference room for this user. | Mandatory |
| plcmConferenceRoomAliasList | List of plcm-conference-room-alias | See Definition of plcm-conference-room-alias |
| Name | Type | Restrictions |
|---|---|---|
| OriginalPassword | xs:string | Length of value must be >=1 Length of value must be <=128 |
| ConferencePasscode | xs:string | Length of value must be >=1 Length of value must be <=128 |
| ChairpersonPasscode | xs:string | Length of value must be >=1 Length of value must be <=128 |
| EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
| Passthru | xs:string | Length of value must be >=1 Length of value must be <=512 |
| Passback | xs:string | Length of value must be >=1 Length of value must be <=512 |
| Password | xs:string | Length of value must be >=1 Length of value must be <=128 |
| PhoneNumber | xs:string | Length of value must be >=1 Length of value must be <=24 |
| City | xs:string | Length of value must be >=1 Length of value must be <=64 |
| Department | xs:string | Length of value must be >=1 Length of value must be <=64 |
| Title | xs:string | Length of value must be >=1 Length of value must be <=64 |
| Tenant | xs:base64Binary | Length of value must be >=16 Length of value must be <=16 |
| EmailAddress | xs:string | Length of value must be >=1 Length of value must be <=512 |
| Domain | xs:string | Length of value must be >=1 |
| LastName | xs:string | Length of value must be >=1 Length of value must be <=256 |
| FirstName | xs:string | Length of value must be >=1 Length of value must be <=256 |
| Username | xs:string | Length of value must be >=1 Length of value must be <=256 |