Skip to content

Schemas

Schemas define the structure and types of data that can be used in SCIM resources, such as Users and Groups. Each SCIM resource is associated with one or more schemas that define the attributes the resource can have.

The SCIM protocol defines a set of standard schemas, such as "User" and "Group", but service providers can also define their own custom schemas.

List Schemas

To retrieve information about the schemas supported by a service provider, you can send a GET request to the /Schemas endpoint. The response will be a JSON object listing all the schemas supported by the service provider, along with their attributes and other details.

Get User Schema

To retrieve the User Schema with the SCIM protocol, you would send a GET request to the /Schemas/urn:ietf:params:scim:schemas:core:2.0:User endpoint. This endpoint represents the User schema as defined by the SCIM protocol.

The response from this endpoint will be a JSON object representing the User schema. This object includes a list of all the attributes a User resource can have, along with their characteristics such as their data type, whether they are required or optional, read-only or read-write, singular or multi-valued, and so on.

Get Group Schema

Retrieving the Group Schema is very much like the User Schema. Just provide another identifier.