List Schemas

get https://{hostname}/scim/v1/Schemas

Use this endpoint to get a list of resource type schemas supported by the SCIM server.

Response

Response body

array of objects

object

attributes

array of objects

required

attributes*

object

canonicalValues

array of strings | null

A collection of suggested canonical values that MAY be used.

canonicalValues

caseExact

boolean

A Boolean value that specifies whether or not a string attribute is case sensitive.

description

string

The attribute's human-readable description.

multiValued

boolean

A Boolean value indicating the attribute's plurality.

mutability

string

A single keyword indicating the circumstances under which the value of the attribute can be (re)defined.

readOnly readWrite immutable writeOnly

name

string

The attribute's name.

referenceTypes

array of strings | null

A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced.

referenceTypes

required

boolean

Specifies whether or not the attribute is required.

returned

string

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.

always never default request

subAttributes

array of objects

subAttributes

object

canonicalValues

array of strings | null

A collection of suggested canonical values that MAY be used.

canonicalValues

caseExact

boolean

A Boolean value that specifies whether or not a string attribute is case sensitive.

description

string

The attribute's human-readable description.

multiValued

boolean

A Boolean value indicating the attribute's plurality.

mutability

string

A single keyword indicating the circumstances under which the value of the attribute can be (re)defined

readOnly readWrite immutable writeOnly

name

string

The attribute's name.

referenceTypes

array of strings | null

A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced.

referenceTypes

required

boolean

Specifies whether or not the attribute is required.

returned

string

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.

always never default request

type

string

The attribute's data type. Valid values are 'string', 'boolean', 'decimal', 'integer', 'dateTime', 'reference', and 'complex'.

uniqueness

string

A single keyword value that specifies how the service provider enforces uniqueness of attribute values.

none server global

type

string

The attribute's data type. Valid values are 'string', 'boolean', 'decimal', 'integer', 'dateTime', 'reference', and 'complex'.

uniqueness

string

A single keyword value that specifies how the service provider enforces uniqueness of attribute values.

none server global

description

string

required

The schema's human-readable description.

string

required

The unique URI of the schema.

200Returns a list of supported resource type schemas.