Skip to main content

SchemaListResponse

List response containing Schema definitions

schemasstring[]
Example: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
totalResultsinteger
itemsPerPageinteger
startIndexinteger
Resources object[]
  • Array [
  • schemasstring[]
    idstring

    Schema URN identifier

    Example: urn:ietf:params:scim:schemas:core:2.0:User
    namestring

    Schema name

    Example: User
    descriptionstring
    Example: User Account
    attributes object[]
  • Array [
  • namestring

    Attribute name

    typestring

    Attribute data type

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

    multiValuedboolean

    Whether the attribute is multi-valued

    descriptionstring
    requiredboolean
    caseExactboolean

    For strings, whether matching is case-sensitive

    canonicalValuesstring[]

    Allowed values for enum-like attributes

    mutabilitystring

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

    returnedstring

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

    uniquenessstring

    Possible values: [none, server, global]

    referenceTypesstring[]

    For type: reference attributes only — list of SCIM resource types that may be referenced (RFC 7643 §7).

    subAttributes []

    Nested attributes for complex types

  • Array [
  • circular(SchemaAttribute)
  • ]
  • ]
  • meta object
    resourceTypestring
    Example: Schema
    locationstring
  • ]
  • SchemaListResponse
    {
    "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
    ],
    "totalResults": 0,
    "itemsPerPage": 0,
    "startIndex": 0,
    "Resources": [
    {
    "schemas": [
    "string"
    ],
    "id": "urn:ietf:params:scim:schemas:core:2.0:User",
    "name": "User",
    "description": "User Account",
    "attributes": [
    {
    "name": "string",
    "type": "string",
    "multiValued": true,
    "description": "string",
    "required": true,
    "caseExact": true,
    "canonicalValues": [
    "string"
    ],
    "mutability": "readOnly",
    "returned": "always",
    "uniqueness": "none",
    "referenceTypes": [
    "string"
    ],
    "subAttributes": [
    null
    ]
    }
    ],
    "meta": {
    "resourceType": "Schema",
    "location": "string"
    }
    }
    ]
    }