User (v3)
Overview
Represents a user.Members
Member variables of the entity:
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 | |
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:
| ||
recorderLinePIN | String | Recorder Line PIN | ||
agentId | String | Contact Center Agent ID or Cisco Owner User ID. | ||
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> | |||
workflowId | Integer | Linked approval workflow ID | ||
location | String | User location | ||
siteId | String | Linked site ID | ||
retentionDays | Integer | User-based data retention period | ||
retentionAutoDelete | boolean | Delete automatically the conversations after the retention period is over | ||
customs | List<String> | Custom user attributes 1-10 | ||
annPromptInbound | boolean | Play notification for PSTN/federated inbound SfB/Lync calls | ||
annPromptOutbound | boolean | Play notification for PSTN/federated outbound SfB/Lync calls | ||
annPromptConference | boolean | Play notification for conference SfB/Lync calls | ||
annFileInbound | String | PSTN/federated inbound announcement audio file for SfB/Lync calls | ||
annFileOutbound | String | PSTN/federated outbound announcement audio file for SfB/Lync calls | ||
annFileConference | String | Conference announcement audio file for SfB/Lync calls | ||
annFileMoh | String | Music on hold announcement audio file for PSTN/federated outbound SfB/Lync calls | ||
annMessageConference | String | IM notification message for SfB/Lync conference calls | ||
annPromptInboundCisco | boolean | Play notification for PSTN/federated inbound Cisco calls | ||
annFileInboundCisco | String | Media Resource ID for Cisco Inbound Calls | ||
annPromptOutboundCisco | boolean | Play notification for PSTN/federated outbound Cisco calls | ||
annFileOutboundCisco | String | Media Resource ID for Cisco Outbound Calls | ||
annPromptInternalTeams | boolean | Play notification for internal Microsoft Teams calls | ||
annPromptInboundTeams | boolean | Play notification for PSTN/federated inbound Microsoft Teams calls | ||
annPromptOutboundTeams | boolean | Play notification for PSTN/federated outbound Microsoft Teams calls | ||
annPromptConferenceTeams | boolean | Play notification for conference Micorosft Teams calls |