SCIM is implemented via a REST API. SCIM API endpoints are secured using the Transport Layer Security (TLS) protocol version 1.2.
SCIM requests must be authenticated using Basic Authentication; an api token is required for all requests.
The following operations are supported at this time:
Create, List, and Update User Accounts
Create, List, Update, and Delete Agent Groups
Create, List, Update, and Delete User Groups
Updating users encompasses activating and deactivating accounts, changing roles, and updating group access.
MaestroQA terms to be aware of:
Users - These refer to User Accounts, not agents to be graded, in MaestroQA.
Groups - the
Groupsendpoints modify agent groups, the
Usergroupsendpoints modify user groups
Active - Whether or not this user can access MaestroQA. This does not refer to agent availability.
See below for usage details and the full list of endpoints and operations supported.
In order to use this API - you will need to first generate an API token.
Summary of Operations
The following operations are supported.
BASE_URL = https://app.maestroqa.com/api/v1/scim/v2
Create User - POST to BASE_URL/Users
Get Users - GET to BASE_URL/Users
Get User By Id - GET to BASE_URL/Users/:UserId
Modify/Deactivate/Update User - PUT to BASE_URL/Users/:UserId
Groups endpoints (Agent Groups)
Create Group - POST to BASE_URL/Groups
Get Groups - GET to BASE_URL/Groups
Get Group By Id - GET to BASE_URL/Groups/:GroupId
Modify Group - PUT to BASE_URL/Groups/:GroupId
Modify Group - PATCH to BASE_URL/Groups/:GroupId
Delete Group - DELETE to BASE_URL/Groups/:GroupId
Groups endpoints (User Groups)
Create Group - POST to BASE_URL/Usergroups
Get Groups - GET to BASE_URL/Usergroups
Get Group By Id - GET to BASE_URL/Usergroups/:GroupId
Modify Group - PUT to BASE_URL/Usergroups/:GroupId
Modify Group - PATCH to BASE_URL/Usergroups/:GroupId
Delete Group - DELETE to BASE_URL/Usergroups/:GroupId
Roles endpoints (Roles)
Get Roles - GET to BASE_URL/Roles/
Get Users By RoleId - GET to BASE_URL/Roles/:roleID
Modify roles - PATCH to BASE_URL/Roles/:roleID