Create and manage users via SCIM

After you connect your external identity provider (IdP) to qTest Manager through System for Cross-domain Identity Management (SCIM 2.0), we recommend that you use your IdP as the central management platform for the following changes:

• Create user

• Deactivate and reactivate users

• Add and remove users from groups

Create users via SCIM

A SCIM user account can contain many attributes, but qTest Manager stores a simple user record.

When you create a user through SCIM, qTest Manager requires the following information:

POST /scim/v2/Users
Content-Type: application/scim+json

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "jdoe@example.com",
  "name": {
    "givenName": "Jane",
    "familyName": "Doe"
  },
  "emails": [
    { "value": "jdoe@example.com", "type": "work", "primary": true }
  ],
  "active": true
}

201 Created
Content-Type: application/scim+json

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "id": "12345",
  "userName": "jdoe@example.com",
  "name": {
    "givenName": "Jane",
    "familyName": "Doe",
    "formatted": "Jane Doe"
  },
  "emails": [
    { "value": "jdoe@example.com", "type": "work", "primary": true }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "location": "/scim/v2/Users/12345"
  }
}

Email handling

When qTest Manager receives a request to create a user through SCIM, it uses only the first value of emails. qTest ignores the sub-attributes emails[].type and emails[].primary.

Responses always return the stored email as type: "work" and primary: true.

Manage user activation via SCIM

You can activate or deactivate qTest users through PATCH /scim/v2/Users/{id} with the active path.

To manage user activation, use the boolean active path:

• true: Activates a user. This sets the user's Status to Active on the Licenses page.

• false: Archives a user. This sets the user's Status to Inactive on the Licenses page.

PATCH /scim/v2/Users/12345
Content-Type: application/scim+json

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "active", "value": false }
  ]
}

Manage group membership

You can add or remove group members through PATCH /scim/v2/Groups/{groupName}.

Access groups according to the group displayName, not the ID. This is from the Group Name defined in User Groups. Your path will look like this when you read or update a group: /scim/v2/Groups/QA Team.

Groups only support member operations, as our SCIM API doesn't currently support nested groups. The members[].value field must be the numeric qTest user ID assigned when you created the user.

PATCH /scim/v2/Groups/QA Team
Content-Type: application/scim+json

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [{ "value": "12345" }]
    }
  ]
}

List, filter, and paginate users and groups

Filtering support is deliberately narrow. Any filter outside the supported attributes and operators returns 400 Bad Request with scimType: invalidFilter.

Filter keywords are case-insensitive, with a maximum filter length of 512 characters and max quoted value of 256 characters.

qTest Manager supports the following filters:

Query parameters

See the table below to see which parameters qTest Manager supports, or doesn't support, for GET /Users and GET /Groups:

Error responses

Failed SCIM requests return a SCIM error object:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "400",
  "scimType": "invalidSyntax",
  "detail": "Description of the error."
}

Common scimType values include invalidSyntax, invalidFilter, and forbidden.

Here are the responses you should be familiar with:

What's next

For full endpoint reference and interactive examples, use the SCIM 2.0 API documentation in Download qTest Resources .