Generic SCIM Endpoint - List Users

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.

Parameter
Description
Example

count

Allows the response to be paginated per the specified number of rows

1

filter

Filters the response results; must be in the format userName%20eq%20%22…%22 where is the username

userName%20eq%20%22aliceglick%22

startIndex

Allows further results to be provided incrementally

0

Example requests

Example request with filter

GET app.strongdm.com/provisioning/generic/v2/Users?filter=userName%20eq%20%[email protected]%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": "[email protected]"
        }
      ],
      "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": "[email protected]",
      "userType": "user"
    }
  ],
  "itemsPerPage": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 5
}

Last updated

Was this helpful?