1. Docs
  2. API Reference
  3. List the SCIM schemas

List the SCIM schemas

GET/scim/v2/directories/{directoryId}/Schemas

SCIM 2.0 (RFC 7644 §4). Lists the core User and Group schemas and the attributes this service provider reads from them, as a SCIM ListResponse.

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

Responses

application/scim+json

  • schemasstring[]*
  • totalResultsnumber*
  • startIndexnumber*

    1-based

  • itemsPerPagenumber*
  • Resourcesany object[]*

    The `ResourceType` or `Schema` resources for Users and Groups (RFC 7643 sections 6 and 7)

application/scim+json

  • schemasstring[]*
  • statusstring*

    The HTTP status, as a string

  • detailstring*
  • scimTypestring

    Present for some refusals, e.g. `uniqueness`

Returned object

ScimDiscoveryListDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/scim/v2/directories/value/Schemas"
Response
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 0,
  "startIndex": 0,
  "itemsPerPage": 0,
  "Resources": [
    {}
  ]
}
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy