plcm-user-v4.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-user-v4  PlcmUserV4

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.


Complex Types

PlcmUserV4 Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcm-service-class-v2 plcm-service-class-v2See Definition of plcm-service-class-v2
plcm-user-group-role-list plcm-user-group-role-listSee Definition of plcm-user-group-role-list
plcm-user-role-list plcm-user-role-listSee Definition of plcm-user-role-list
usernameUsername 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-nameFirstName The user's first name. Mandatory for local users, but optional for enterprise users.
last-nameLastName The user's last name. Mandatory for local users, but optional for enterprise users.
domainDomain 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-addressEmailAddress The email address of the user.
tenantTenant A UUID that identifies the area to which this user belongs.
titleTitle The title of the user.
departmentDepartment The department of the user.
cityCity The city of the user.
phone-numberPhoneNumber The phone number of the user.
passwordPassword The local user's system login password (not conference or chairperson passcode). The password must satisfy the local password rules specified for the system.
disabledxs:boolean Disabled users do not have conferencing privileges and cannot log into the UI or API.
lockedxs: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-requiredxs:boolean User must change password to obtain authorization.
groupsList of xs:string group membership UUIDs
passbackPassback User defined value for that is opaque to the system.
passthruPassthru 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.
uuidxs:string
entity-tagEntityTag 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-passcodeChairpersonPasscode The local user's chairperson passcode.
conference-passcodeConferencePasscode The local user's conference passcode.
override-chairperson-passcodexs:boolean Override local user's chairperson passcode.
override-conference-passcodexs:boolean Override local user's conference passcode.
enterprise-chairperson-passcodexs:string The enterprise user's chairperson passcode. This field is read-only.
enterprise-conference-passcodexs:string The enterprise user's conference passcode. This field is read-only.
territory-namexs:string Territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
svc-only-territory-namexs:string SVC-Only territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
conference-roomList of ConferenceRoom
override-default-territory-namexs: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-namexs: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-classxs: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-passwordOriginalPassword 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.

ConferenceRoom Fields

NameTypeDescriptionAttributes
conference-room-identifierxs:string Read-only identifier of a conference room for this user. Mandatory
plcmConferenceRoomAliasList List of plcm-conference-room-aliasSee Definition of plcm-conference-room-alias


Simple Types


NameTypeRestrictions
OriginalPasswordxs:string
Length of value must be >=1
Length of value must be <=128
ConferencePasscodexs:string
Length of value must be >=1
Length of value must be <=128
ChairpersonPasscodexs:string
Length of value must be >=1
Length of value must be <=128
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
Passthruxs:string
Length of value must be >=1
Length of value must be <=512
Passbackxs:string
Length of value must be >=1
Length of value must be <=512
Passwordxs:string
Length of value must be >=1
Length of value must be <=128
PhoneNumberxs:string
Length of value must be >=1
Length of value must be <=24
Cityxs:string
Length of value must be >=1
Length of value must be <=64
Departmentxs:string
Length of value must be >=1
Length of value must be <=64
Titlexs:string
Length of value must be >=1
Length of value must be <=64
Tenantxs:base64Binary
Length of value must be >=16
Length of value must be <=16
EmailAddressxs:string
Length of value must be >=1
Length of value must be <=512
Domainxs:string
Length of value must be >=1
LastNamexs:string
Length of value must be >=1
Length of value must be <=256
FirstNamexs:string
Length of value must be >=1
Length of value must be <=256
Usernamexs:string
Length of value must be >=1
Length of value must be <=256