List or filter users

GET

/scim/v2/directories/{directoryId}/Users

SCIM 2.0 (RFC 7644 §3.4.2). Lists this directory's users as a SCIM ListResponse. filter supports userName eq and externalId eq, optionally joined by and; startIndex and count page the result (at most 500 per page). Errors use SCIM's error schema (RFC 7644 §3.12).

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

Query Parameters

filterstring Required

startIndexstring Required

countstring Required

Responses

application/scim+json

schemasstring[]*
totalResultsnumber*
startIndexnumber*
1-based
itemsPerPagenumber*
ResourcesScimUserDto[]*

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

Returned object

ScimUserListDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/scim/v2/directories/value/Users?filter=value&startIndex=value&count=value"

Response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 0,
  "startIndex": 0,
  "itemsPerPage": 0,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "string",
      "externalId": "string",
      "userName": "string",
      "name": {
        "givenName": "string",
        "familyName": "string"
      },
      "emails": [
        {
          "value": "string",
          "primary": false,
          "type": "work"
        }
      ],
      "active": false,
      "meta": {
        "resourceType": "User",
        "created": "2026-04-20T12:00:00.000Z",
        "lastModified": "2026-04-20T12:00:00.000Z",
        "location": "string",
        "version": "string"
      }
    }
  ]
}

Was this page helpful?

Tell us how we can improve this guide.