Get Get Schemas

Get Get Schemas

It is not possible to list all the available schemas, a filter must be specified. The filter only supports the equality operator ('eq') on the 'name' attribute

Request
URI
GET
https://{api_host}//SAAS/jersey/manager/api/scim/Schemas
COPY
Query Parameters
string
filter
Optional

Only schemas matching the filter expression will be returned. Only 'eq' is supported as an operator for this filter

filter example
name eq "User"
string
directoryUuid
Optional

The directory UUID. If specified, the schema associated to this particular directory will be returned as well, if any. Only available for the 'User' schema

directoryUuid example
name eq "User"
string
customSchemaExtensionTypes
Optional

The list of custom schemas separated by a comma. If specified, the specified schema(s) attributes will be returned as well. Only available for the 'User' schema


Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResourceDescriptor of type(s) application/json
{
    "endpoint": "string",
    "description": "string",
    "name": "string",
    "attributeSchemas": [
        "string"
    ],
    "strictMode": false,
    "scimObject": {
        "schemas": [
            "string"
        ]
    },
    "meta": {
        "lastModified": "string",
        "version": "string",
        "location": "string",
        "created": "string"
    },
    "externalId": "string",
    "attributes": [
        {
            "subAttributes": [
                "AttributeDescriptor Object"
            ],
            "description": "string",
            "canonicalValues": [
                {
                    "operation": "string",
                    "type": "string",
                    "primary": false,
                    "value": "string",
                    "display": "string"
                }
            ],
            "dataType": "string",
            "required": false,
            "caseExact": false,
            "name": "string",
            "readOnly": false,
            "multiValuedChildName": "string",
            "multiValued": false,
            "schema": "string"
        }
    ],
    "schema": "string",
    "id": "string",
    "resourceDescriptor": "ResourceDescriptor Object"
}
string
endpoint
Optional

endpoint

string
description
Optional

description

string
name
Optional

name

array of string
attributeSchemas
Optional

attributeSchemas

boolean
strictMode
Optional

strictMode

scimObject
Optional

scimObject

meta
Optional

meta

string
externalId
Optional

externalId

attributes
Optional

attributes

string
schema
Optional

schema

string
id
Optional

id

resourceDescriptor
Optional

resourceDescriptor


400

No "filter" has been specified or the specified "filter" is invalid: an operator other than 'eq' has been specified, the given schema does not exist or the equality is not based on the 'name'

Operation doesn't return any data structure