Users Overview #

The Customer Users resource allows for the management of users at a customer level. The base URI for all request is:

/{VERSION}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}

Customer Users Schema #

Users represent an end user of the system.

Key	Description	Type	Default	Required
id	The unique User identifier	string	(auto generated)	Yes (not create)
displayName	A full User display name	string[100]		Yes
email	The email address of the User	string[200]		Yes
roles	Collection of roles	roles
primaryTenant	The id of the Users primary tenant	string
isParent	Used to indicate whether the user is configured at a higher level e.g. Reseller-Level	bool

Roles #

User Access Type #

These roles control what PBX feature licenses are assigned to a User, changing these may incur charges.

Key	Name	Description	Pre-requisite	Licensed
customer.user.pbx¹,²	Essential User	This enables call modeling/logging for the User.		✔
customer.user.uc.remote	Professional User	Controls access to the Softphone and Connect Mobile features.	customer.user.uc	✔
customer.user.pbx.realtime³	Real-Time Add-On	Required for real-time call modeling for the user.	customer.user.pbx	✔
customer.user.acd	Agent User Add-On	Controls modeling of ACD events and access to ACD features of Connect.	customer.user.pbx	✔

info
Optionally, the customer.user.acd role can be automatically assigned to a user if they are detected as being a Call Center Pro user on a ~.pbx.kazoo.name.~ system. This feature is controlled by a Customer level setting which can be configured through the reseller portal.

Supervisor Access Roles #

These control which access licenses are assigned to a User, changing these may incur charges.

warning
These are mutually exclusive, with the higher roles allow access to all of the features of the lower roles. Ensure that only a single access license role is assigned to a User at one time.

Key	Name	Description	Pre-requisite	Licensed
customer.user.supervisorl1	Reports Supervisor	Provides the user with access to Workspaces & Historical Reports	customer.user
customer.user.supervisorl2	Analytics Supervisor	Provides the user access to the Dashboard and Historical Reports	customer.user	✔
customer.user.supervisorl3	Live Analytics Supervisor	Provides the user access to the Reports/Dashboard/Wallboard including active call stats.	customer.user	✔
customer.user.supervisorl4	Contact Center Supervisor	Provides the user access to the Reports/Dashboard/Wallboard including active call stats and queue/agent live grids.	customer.user	✔

Permission Roles #

These control the user’s permissions and the areas which they can access.

Key	Name	Description	Pre-requisite	Licensed
user.admin	Manage Users	Allows the user to manage other users through the customer portal.
customer.user	Website Access	Allows the user to login into the Customer Reseller Portal.
customer.user.uc	Connect Desktop	Allows the user access to use the Connect Desktop application.	customer.user
customer.user.uc.softphone	Connect Softphones	Controls access to the Softphone features of Connect.	customer.user.uc
customer.user.uc.microsoftteams	Enable Microsoft Teams Integration	Controls the access to enable Microsoft Teams integration.	customer.user.uc
customer.user.crm	CRM User Add-On	This enables the CRM client role for the User. Once enabled, users can login to the available CRM integrations (e.g. Salesforce, Dynamics).	customer.user	✔
customer.settings	Customer Settings	Allows the user to manage the customer account settings (e.g. Area codes, Timers etc)	customer.user
customer.billables.admin	Manage Billable Items	Allows the user to make changes to other users which will have an effect on the cost of using the system	customer.user
recording.observer	Recording Playback	Gives the user access to playback recordings from the Call Segmentation view	customer.user

warning
When granting the user.admin role, they will also require the customer.user role to be able to login to the Customer portal. There must always be a single User that has both the user.admin and customer.user role otherwise you may receive the error “There must be at least one user administrator.”

Available Interfaces #

Interface	Description
Get All	Returns a collection of all customer users.
Get User	Returns a specific customer user instance.
Create User	Creates a new customer user instance.
Patch User	Updates an existing customer user instance.
Update User Device	Assign or remove devices as a Softphone.
Delete User	Removes an existing customer user instance.
Send Activation Email	Sends the customer user an activation email link so they can authenticate with the system.

In the UK, the customer.user.uc.essential role should be used. ↩︎
This role will be automatically assigned to any user that exists on the communications platform ↩︎
This role will be automatically assigned to any user with the customer.user.pbx role when the first customer.user.supervisorl3 role or above is assigned to a user. ↩︎