Get schema

Get individual SCIM schema

GET /api/v1/scim/v2/Schemas/{schemaId}

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id": "urn:ietf:params:scim:schemas:extension:2.0:Role",
  "name": "Role",
  "description": "Role Schema",
  "attributes": [
    {
      "name": "value",
      "type": "string",
      "multiValued": false,
      "description": "The value of the role",
      "required": true,
      "caseExact": false,
      "mutability": "readOnly",
      "returned": "default",
      "uniqueness": "none"
    },
    {
      "name": "display",
      "type": "string",
      "multiValued": false,
      "description": "Human-readable name for the role",
      "required": false,
      "caseExact": false,
      "mutability": "readOnly",
      "returned": "default",
      "uniqueness": "none"
    },
    {
      "name": "type",
      "type": "string",
      "multiValued": false,
      "description": "Label indicating the role function",
      "required": false,
      "caseExact": false,
      "mutability": "readOnly",
      "returned": "default",
      "uniqueness": "none"
    },
    {
      "name": "supported",
      "type": "boolean",
      "multiValued": false,
      "description": "Boolean indicating if the role is usable",
      "required": true,
      "caseExact": false,
      "mutability": "readOnly",
      "returned": "default",
      "uniqueness": "none"
    }
  ]
}

Path Parameters

schemaId · string · required

schema identifier

Response

200 - application/json

Ok

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:schemas:core:2.0:Schema

id · string · required

attributes · object[] · required

Show child attributes

meta · object

Show child attributes

name · string

description · string