User (v2)

Owned by Kiss, Mate
Feb 23, 2024
1 min read

Overview

Represents a user.

Members

Member variables of the entity:

MemberType

Description

RequirementsMax. Length
idInteger User ID  
loginNameStringLogin name 64
passwordHashString Password hashed using MD5 32
displayNameStringLong display name of the user 64
emailString Email address 128
crmUserIdString CRM User ID for integration with other systems  
languageString User interface language 32
timeZoneString Time zone in standard Java time zone format 100
validFromDate Start of the user's validity period
User does not see calls made before this date
and can not log in until this date		  
validToDate End of the user's validity period
User does not see calls made after this date
and can not log in after this date		  
lockedbooleanLocked status, locked users can not access the system  
eidString Enterprise ID (4 characters long)Needed if environmentShortName
is not present		4
environmentShortNameString Enterprise short nameNeeded if eid
is not present		64
nonModifiablebooleanCan the user's properties be modified  
passwordExpiresbooleanShows whether the password will expire or not  
needChangePasswordboolean

Shows whether user Must Change Password at Next Logon

  
observerUserIdInteger Observer User ID for 'four eyes login'  
observerGroupIdIntegerObserver Group ID for 'four eyes login'  
userTypeString

Type of the user:

  • Standard user - standard Verba system users with all the functionalities. (Value is: 'user_type_verba')
  • Publishing Server user - Verba Publishing Server users only with very limited functionality. (Value is: 'user_type_shared_items')
  
recorderLinePINStringRecorder Line PIN  
agentIdString

Contact Center Agent ID or Cisco Owner User ID.
It's visible on the Verba Web Interface under the User's properties only when the following registry is present:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Verba\Web\ShowUserAgentID (DWORD) = 1 

  
apiAccessOnlybooleanAPI Access Only  
customDateFormatStringOptional custom date format for the user  
customTimeFormatStringOptional custom time format for the user  
externalIdStringExternal ID for integration with other systems  
extensionsList<Extension> List of extensions associated with the user,
a user has access to calls on extensions associated with it		  
groupMembershipsList<GroupMembership>   
rolesList<String>