Get schema

GET 
/nevisidm/api/scim/v1/Schemas/:id

Retrieves a single SCIM schema definition by its schema URI. The schema describes all attributes, their types, mutability, and other metadata for a particular SCIM resource type.

Request

Path Parameters

id stringrequired
Schema's internal identifier.
Example: urn:ietf:params:scim:schemas:core:2.0:User

Responses

200

Schema retrieved successfully

application/json

Schema

Schema

schemas string[]required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

id stringrequired

The unique URI of the schema.

name stringrequired

The schema's human-readable name.

description string

The schema's human-readable description.

attributes ScimAttribute[]required
List of attributes of schema related resource.
Array [
name stringrequired
The attribute's name.
type stringrequired
Possible values: [string, boolean, decimal, integer, dateTime, reference, complex]
The attribute's data type.
subAttributes undefined[]required
When an attribute is of type "complex", this defines a set of sub-attributes.
multiValued booleanrequired
A Boolean value indicating the attribute's plurality.
description string
The attribute's human-readable description.
required booleanrequired
A Boolean value that specifies whether or not the attribute is required.
canonicalValues string[]
A collection of suggested canonical values that MAY be used.
caseExact booleanrequired
A Boolean value that specifies whether or not a string attribute is case sensitive.
mutability stringrequired
Possible values: [readOnly, readWrite, immutable, writeOnly]
A single keyword indicating the circumstances under which the value of the attribute can be defined.
returned stringrequired
Possible values: [always, never, default, request]
A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request.
uniqueness stringrequired
Possible values: [none, server, global]
A single keyword value that specifies how the service provider enforces uniqueness of attribute values.
]

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "urn:ietf:params:scim:schemas:core:2.0:User",
  "name": "User",
  "description": "SCIM provides a resource type for \"User\" resources.",
  "attributes": 100
}

User schema

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"],
  "id": "urn:ietf:params:scim:schemas:core:2.0:User",
  "name": "User",
  "description": "SCIM provides a resource type for User resources.",
  "attributes": [
    {
      "name": "userName",
      "type": "string",
      "multiValued": false,
      "description": "Unique identifier for the User.",
      "required": true,
      "caseExact": false,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "server"
    },
    {
      "name": "name",
      "type": "complex",
      "multiValued": false,
      "description": "The components of the user's name.",
      "required": false,
      "caseExact": false,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "none",
      "subAttributes": [
        {
          "name": "familyName",
          "type": "string",
          "multiValued": false,
          "required": false,
          "caseExact": false,
          "mutability": "readWrite",
          "returned": "default",
          "uniqueness": "none"
        }
      ]
    }
  ]
}

400

Invalid meta request

application/json

Schema

Schema

schemas string[]required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

status HttpStatusCoderequired
The HTTP status code.
error boolean
is1xxInformational boolean
is2xxSuccessful boolean
is3xxRedirection boolean
is4xxClientError boolean
is5xxServerError boolean
scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

A SCIM detail error keyword.

detail string

A detailed human-readable message.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "status": 400,
  "scimType": "invalidValue",
  "detail": "The requested user '999' does not exist in IDM database."
}

Schema not found

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
  "status": "BAD_REQUEST",
  "scimType": "invalidValue",
  "detail": "No schema found for the given schema ID: urn:invalid:schema"
}

Loading...