Generic SCIM Endpoint - List Users

Last modified on March 24, 2023

The List Users endpoint returns either all users within an organization matching the given filter or all users if no filter is provided.

Request

Endpoint

/provisioning/generic/v2/Users

HTTP Method

GET

Path parameters

The following path parameters are optional.

ParameterDescriptionExample
countAllows the response to be paginated per the specified number of rows1
filterFilters the response results; must be in the format userName%20eq%20%22…%22 where … is the usernameuserName%20eq%20%22aliceglick%22
startIndexAllows further results to be provided incrementally0

Example requests

Example request with filter

GET app.strongdm.com/provisioning/generic/v2/Users?filter=userName%20eq%20%22myUser@example.test%22

Example request without filter

GET app.strongdm.com/provisioning/generic/v2/Users?startIndex=0&count=1

Response

Example success response 

(Status 200)

{
  "Resources": [
    {
      "active": true,
      "displayName": "Firstname Lastname",
      "emails": [
        {
          "primary": true,
          "value": "myUser@example.test"
        }
      ],
      "groups": [],
      "id": "a-01ba754f6171667f",
      "meta": {
        "resourceType": "User",
        "location": "Users/a-01ba754f6171667f"
      },
      "name": {
        "familyName": "Lastname",
        "formatted": "Firstname Lastname",
        "givenName": "Firstname"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "userName": "myUser@example.test",
      "userType": "user"
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 5
}