Import or update users via API

Overview

You can use our GraphQL API to import your users, create new ones or update them automatically.

Importing or modifying users allows you to automate the management of your users to:

• create your users in bulk,

• synchronize your users between applications (i.e. user provisioning),

• automate the creation of a user according to your needs,

• update user information (username, password, group, ...),

• modify the configuration of your users' communication channels

• etc.

Prerequisites

API authentication uses temporary and revocable access keys (tokens). Please note that the lifetime of the key is 24 hours.

To generate your access key, please refer to this section.

Steps to follow

Importing your users

The userCreate resource of our GraphQL API allows you to specify all the information available when creating your users.

mutation MyMutation {
  userCreate(input: {lastName: "", email: "", password: "", roleId: "", userName: "", avatar: "", projectIds: "", firstName: ""})
}

Updating your users

The userUpdate resource of our GraphQL API allows you to update all the information of your users.

mutation MyMutation {
  userUpdate(input: {userId: "", firstName: "", lastName: ""})
}

Main information

Information	Description
firstName	First name of the user
lastName	Last name of the user
email	User's email
password	User's password
roleId	User role identifier: advisor, manager, administrator,...
userName	The username that will be displayed in the dialogue window
avatar	A portrait of the advisor can be displayed in the dialogue window. (The image must be less than 1MB, 1000px by 1000px in PNG, jpg, or gif format, with automatic resizing applied afterward)
channels	The channels object of this resource allows you to specify the configuration of the different channels (chat, call, video, third party channels) for the user to be created: channel activation, number of configured slots, etc
skills	List of competency identifiers assigned to the user
Project Ids	The identifiers of the projects accessible to this user
groupId	User group identifier
Country preferences	User localization: main language, spoken languages, time zone, date/time format
externalID	External user ID
samlId	SAML identifier of the user for the use of SSO

Good practices

• The user or users queries allow you to retrieve the information of the users you've created.

• You can easily manage your users' skills with the following resources:

  • userSkillsAdd

  • userSkillsRemove

  • userSkillsSet

• The userDelete resource allow you to delete a user if needed