PlcmUserV4

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.

PlcmUserV4 Fields

Name	Type	Description	Attributes
atomLinkList	Array of Link	See Definition of Link
plcmServiceClassV2	PlcmServiceClassV2	See Definition of PlcmServiceClassV2
plcmUserGroupRoleList	PlcmUserGroupRoleList	See Definition of PlcmUserGroupRoleList
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.
groups	Array of 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	string
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.
chairpersonPasscode	ChairpersonPasscode	The local user's chairperson passcode.
conferencePasscode	ConferencePasscode	The local user's conference passcode.
overrideChairpersonPasscode	boolean	Override local user's chairperson passcode.
overrideConferencePasscode	boolean	Override local user's conference passcode.
enterpriseChairpersonPasscode	string	The enterprise user's chairperson passcode. This field is read-only.
enterpriseConferencePasscode	string	The enterprise user's conference passcode. This field is read-only.
territoryName	string	Territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
svcOnlyTerritoryName	string	SVC-Only territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
conferenceRoom	Array of ConferenceRoom
overrideDefaultTerritoryName	boolean	When true, territory-name must be specified in the request. When false, territory-name value will be determined by the system default.
overrideDefaultSvcOnlyTerritoryName	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.
overrideDefaultServiceClass	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.
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.

ConferenceRoom Fields

Name	Type	Description	Attributes
conferenceRoomIdentifier	string	Read-only identifier of a conference room for this user.	Mandatory
plcmConferenceRoomAliasList	Array of PlcmConferenceRoomAlias	See Definition of PlcmConferenceRoomAlias

Nested Types/Restrictions

Name	Type	Restrictions
OriginalPassword	string	Length of value must be >=1 Length of value must be <=128
ConferencePasscode	string	Length of value must be >=1 Length of value must be <=128
ChairpersonPasscode	string	Length of value must be >=1 Length of value must be <=128
EntityTag	string	Length of value must be >=1 Length of value must be <=64
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