SchemaDefinition

Schema definition as defined in RFC 7643 Section 7

attributes object[]required

The schema's attribute definitions

Array [

canonicalValuesstring[]

Suggested canonical values for the attribute

caseExactbooleanrequired

Indicates if the attribute is case-sensitive

descriptionstring

The attribute's human-readable description

multiValuedbooleanrequired

Indicates if the attribute is multi-valued

mutabilitystringrequired

Indicates when the attribute value can be modified

Possible values: [readOnly, readWrite, immutable, writeOnly]

namestringrequired

The attribute's name

referenceTypesstring[]

For reference attributes, the SCIM resource types that may be referenced

requiredbooleanrequired

Indicates if the attribute is required

returnedstringrequired

Indicates when the attribute is returned

Possible values: [always, never, default, request]

subAttributesundefined[]

Sub-attributes for complex attributes

typestringrequired

The attribute's data type

Possible values: [string, boolean, decimal, integer, dateTime, reference, complex]

uniquenessstringrequired

Indicates how uniqueness is enforced

Possible values: [none, server, global]

]

descriptionstring

The schema's human-readable description

idstringrequired

The unique URI of the schema

meta object

Resource metadata as defined in RFC 7643 Section 3.1

createdstring<date-time>

The timestamp when the resource was created

lastModifiedstring<date-time>

The timestamp when the resource was last modified

locationstring<uri>

The URI of the resource

resourceTypestring

The name of the resource type (e.g., User, Group)

versionstring

The version of the resource. Used for ETag-based versioning. Weak ETags are prefixed with W/

namestringrequired

The schema's human-readable name

schemasstring[]required

Possible values: [urn:ietf:params:scim:schemas:core:2.0:Schema]

SchemaDefinition

{
  "attributes": [
    {
      "canonicalValues": [
        "string"
      ],
      "caseExact": true,
      "description": "string",
      "multiValued": true,
      "mutability": "readOnly",
      "name": "string",
      "referenceTypes": [
        "string"
      ],
      "required": true,
      "returned": "always",
      "subAttributes": [
        null
      ],
      "type": "string",
      "uniqueness": "none"
    }
  ],
  "description": "string",
  "id": "string",
  "meta": {
    "created": "2024-07-29T15:51:28.071Z",
    "lastModified": "2024-07-29T15:51:28.071Z",
    "location": "string",
    "resourceType": "string",
    "version": "string"
  },
  "name": "string",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ]
}