BEbeyondidentity
SCIM

List All Schemas

To list all supported resource schemas, send a GET request to /Schemas.

get/scim/v2/Schemas

Request

Response

The response will be a list of JSON objects, each of which contains the standard resource schema attributes.

schemasstring[] required

The list of schemas used to define the list response. This only contains the ListResponse schema ("urn:ietf:params:scim:api:messages:2.0:ListResponse").

totalResultsinteger required

Total number of results matching the request. This value may be larger than the number of resources returned, such as when returning a single page of results where multiple pages are available.

startIndexinteger required

The 1-based index of the first result in the current set of list results.

itemsPerPageinteger required

The number of resources returned in a list response page.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "urn:ietf:params:scim:schemas:core:2.0:User",
      "name": "User",
      "description": "User resource",
      "attributes": [
        {
          "name": "id",
          "type": "string",
          "multiValued": true,
          "description": "The display name of the user.",
          "required": true,
          "caseExact": true,
          "mutability": "readOnly",
          "returned": "default",
          "uniqueness": "none",
          "referenceTypes": [
            "User"
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.