Returns a Schema based on id.

GET 
/Schemas/:schemaId

The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.

Request

Path Parameters

schemaId stringrequired

The id of the Schema.

Responses

200

Returns a single Schema based on the id.

application/json

Schema

Schema

id string

The id of the Schema. The id is the SCIM URN of the Schema.

name string

Name of the Schema.

description string

Description of the Schema.

attributes

undefined[]

Attributes used to describe this Schema.

Array [

uniqueness string

Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources.

name string

Name of the attribute.

description string

Description of the attribute.

mutability string

Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'.

type string

Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.

multiValued boolean

Describes whether this attribute is allowed multiple values.

caseExact boolean

True if attribute value is case-sensitive; false otherwise.

returned string

Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'.

required boolean

True if this attribute is required for this Schema; false otherwise.

canonicalValues string[]

List of canonical values that could be used to supplement attribute.

subAttributes undefined[]

Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema.

]

meta

object

Metadata of the Schema.

location string

The location of the Schema.

version string

The version of the Schema.

resourceType string

The SCIM resource type.

schemas string[]

The schema for the Schema resource.

Example (from schema)

{
  "id": "urn:ietf:params:scim:schemas:sailpoint:1.0:User",
  "name": "User",
  "description": "Schema for a SCIM User.",
  "attributes": [
    {
      "uniqueness": "none",
      "name": "displayName",
      "description": "Display name of the User.",
      "mutability": "readOnly",
      "type": "string",
      "multiValued": false,
      "caseExact": false,
      "returned": "default",
      "required": false,
      "canonicalValues": [
        "httpbasic",
        "httpdigest",
        "oauth"
      ],
      "subAttributes": [
        null
      ]
    }
  ],
  "meta": {
    "location": "http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb",
    "version": "W\"1647617443639\"",
    "resourceType": "Schema"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ]
}

Loading...