/
User (v2)

User (v2)

May 25, 2022

Overview

Represents a user.

Members

Member variables of the entity:

Member

Type

Description

Requirements

Max. Length

Member

Type

Description

Requirements

Max. Length

id

Integer 

User ID

 

 

loginName

String

Login name

 

64

passwordHash

String 

Password hashed using MD5

 

32

displayName

String

Long display name of the user

 

64

email

String 

Email address

 

128

crmUserId

String 

CRM User ID for integration with other systems

 

 

language

String 

User interface language

 

32

timeZone

String 

Time zone in standard Java time zone format

 

100

validFrom

Date 

Start of the user's validity period
User does not see calls made before this date
and can not log in until this date

 

 

validTo

Date 

End of the user's validity period
User does not see calls made after this date
and can not log in after this date

 

 

locked

boolean

Locked status, locked users can not access the system

 

 

eid

String 

Enterprise ID (4 characters long)

Needed if environmentShortName
is not present

4

environmentShortName

String 

Enterprise short name

Needed if eid
is not present

64

nonModifiable

boolean

Can the user's properties be modified

 

 

passwordExpires

boolean

Shows whether the password will expire or not

 

 

needChangePassword

boolean

Shows whether user Must Change Password at Next Logon

 

 

observerUserId

Integer 

Observer User ID for 'four eyes login'

 

 

observerGroupId

Integer

Observer Group ID for 'four eyes login'

 

 

userType

String

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')

 

 

recorderLinePIN

String

Recorder Line PIN

 

 

agentId

String

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 

 

 

apiAccessOnly

boolean

API Access Only

 

 

customDateFormat

String

Optional custom date format for the user

 

 

customTimeFormat

String

Optional custom time format for the user

 

 

externalId

String

External ID for integration with other systems

 

 

extensions

List<Extension> 

List of extensions associated with the user,
a user has access to calls on extensions associated with it

 

 

groupMemberships

List<GroupMembership>

 

 

 

roles

List<String>