Skip to main content

Schemas (SCIM)

Get available SCIM schemas.

Quick Navigation

Endpoint​

GET /scim/v2/Schemas

Headers​

HeaderRequiredDescription
AuthorizationYesBearer <scim_bearer_token>
AcceptYesapplication/scim+json or application/json

Response​

Success (200)​

{
  "totalResults": 1,
  "itemsPerPage": 1,
  "startIndex": 1,
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "Resources": [
    {
      "id": "urn:ietf:params:scim:schemas:core:2.0:User",
      "name": "User",
      "description": "User Account",
      "attributes": [
        {
          "name": "id",
          "type": "string",
          "required": true,
          "caseExact": false,
          "mutability": "readOnly"
        },
        {
          "name": "userName",
          "type": "string",
          "required": true,
          "caseExact": false,
          "mutability": "readWrite"
        },
        {
          "name": "name",
          "type": "complex",
          "required": false,
          "subAttributes": [
            {
              "name": "formatted",
              "type": "string",
              "required": false
            },
            {
              "name": "familyName",
              "type": "string",
              "required": false
            },
            {
              "name": "givenName",
              "type": "string",
              "required": false
            }
          ]
        },
        {
          "name": "active",
          "type": "boolean",
          "required": false,
          "mutability": "readWrite"
        },
        {
          "name": "emails",
          "type": "complex",
          "multiValued": true,
          "required": false,
          "subAttributes": [
            {
              "name": "value",
              "type": "string",
              "required": false
            },
            {
              "name": "primary",
              "type": "boolean",
              "required": false
            }
          ]
        }
      ]
    }
  ]
}

Features​

  • SCIM 2.0 compliant
  • Returns schema definitions for supported resources
  • Includes attribute details and constraints
  • Used for schema discovery

Example​

curl -X GET "https://api.rivergen.com/scim/v2/Schemas" \
  -H "Authorization: Bearer <scim_bearer_token>" \
  -H "Accept: application/scim+json"