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

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmServiceClassV2 PlcmServiceClassV2See Definition of PlcmServiceClassV2
plcmUserGroupRoleList PlcmUserGroupRoleListSee Definition of PlcmUserGroupRoleList
plcmUserRoleList PlcmUserRoleListSee Definition of PlcmUserRoleList
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
firstNameFirstName The user's first name. Mandatory for local users, but optional for enterprise users.
lastNameLastName 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.
emailAddressEmailAddress 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.
phoneNumberPhoneNumber 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.
disabledboolean Disabled users do not have conferencing privileges and cannot log into the UI or API.
lockedboolean 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.
passwordChangeRequiredboolean User must change password to obtain authorization.
groupsArray of 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.
uuidstring
entityTagEntityTag 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.
chairpersonPasscodeChairpersonPasscode The local user's chairperson passcode.
conferencePasscodeConferencePasscode The local user's conference passcode.
overrideChairpersonPasscodeboolean Override local user's chairperson passcode.
overrideConferencePasscodeboolean Override local user's conference passcode.
enterpriseChairpersonPasscodestring The enterprise user's chairperson passcode. This field is read-only.
enterpriseConferencePasscodestring The enterprise user's conference passcode. This field is read-only.
territoryNamestring Territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
svcOnlyTerritoryNamestring SVC-Only territory to which the user’s conference rooms (virtual meeting rooms, or VMRs) are assigned.
conferenceRoomArray of ConferenceRoom
overrideDefaultTerritoryNameboolean When true, territory-name must be specified in the request. When false, territory-name value will be determined by the system default.
overrideDefaultSvcOnlyTerritoryNameboolean 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.
overrideDefaultServiceClassboolean 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.
originalPasswordOriginalPassword 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
conferenceRoomIdentifierstring Read-only identifier of a conference room for this user. Mandatory
plcmConferenceRoomAliasList Array of PlcmConferenceRoomAliasSee Definition of PlcmConferenceRoomAlias


Nested Types/Restrictions


NameTypeRestrictions
OriginalPasswordstring
Length of value must be >=1
Length of value must be <=128
ConferencePasscodestring
Length of value must be >=1
Length of value must be <=128
ChairpersonPasscodestring
Length of value must be >=1
Length of value must be <=128
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Passthrustring
Length of value must be >=1
Length of value must be <=512
Passbackstring
Length of value must be >=1
Length of value must be <=512
Passwordstring
Length of value must be >=1
Length of value must be <=128
PhoneNumberstring
Length of value must be >=1
Length of value must be <=24
Citystring
Length of value must be >=1
Length of value must be <=64
Departmentstring
Length of value must be >=1
Length of value must be <=64
Titlestring
Length of value must be >=1
Length of value must be <=64
Tenantbase64Binary
Length of value must be >=16
Length of value must be <=16
EmailAddressstring
Length of value must be >=1
Length of value must be <=512
Domainstring
Length of value must be >=1
LastNamestring
Length of value must be >=1
Length of value must be <=256
FirstNamestring
Length of value must be >=1
Length of value must be <=256
Usernamestring
Length of value must be >=1
Length of value must be <=256