SCIM is implemented via a REST API. The API endpoint is secured using the Transport Layer Security (TLS) protocol version 1.2.

Currently SCIM is authenticated using Basic Authentication

The following operations are supported at this time:

  • Create, List, and Update MaestroQA User Accounts

  • Create, List, and Update MaestroQA Agent Groups

  • Create, List, and Update MaestroQA 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 "Groups" endpoint modifies agent groups, the "Usergroups" endpoint modifies grader 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 leverage this API - you will need to first generate an API token. Please follow the steps in the link below.

Summary of Operations

The following operations are supported.

BASE_URL = https://app.maestroqa.com/api/v1/scim/v2

User Operations

  1. Create User - POST to BASE_URL/Users

  2. Get Users - GET to BASE_URL/Users

  3. Get User By Id - GET to BASE_URL/Users/:UserId

  4. Modify/Deactivate/Update User - PUT to BASE_URL/Users/:UserId

Groups endpoints (Agent Groups)

  1. Create Group - POST to BASE_URL/Groups

  2. Get Groups - GET to BASE_URL/Groups

  3. Get Group By Id - GET to BASE_URL/Groups/:GroupId

  4. Modify Group - PUT to BASE_URL/Groups/:GroupId

  5. Modify Group - PATCH to BASE_URL/Groups/:GroupId

Groups endpoints (User Groups)

  1. Create Group - POST to BASE_URL/Usergroups

  2. Get Groups - GET to BASE_URL/Usergroups

  3. Get Group By Id - GET to BASE_URL/Usergroups/:GroupId

  4. Modify Group - PUT to BASE_URL/Usergroups/:GroupId

  5. Modify Group - PATCH to BASE_URL/Usergroups/:GroupId

Roles endpoints (Roles)

  1. Get Roles - GET to BASE_URL/Roles/

  2. Get Users By RoleId - GET to BASE_URL/Roles/:roleID

  3. Modify roles - PATCH to BASE_URL/Roles/:roleID

Did this answer your question?