---
title: "List All Schemas"
method: GET
path: "/scim/v2/Schemas"
tags: ["SCIM"]
---

# List All Schemas

`GET /scim/v2/Schemas`

## Request

- Base URL: `https://api.byndid.com`
- URL: `https://api.byndid.com/scim/v2/Schemas`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/docs/scim/v2/Schemas/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Response `200`

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

- object: Response for ListSchemas.
  - `schemas` string[], 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").
  - `Resources` SCIMSchema[], required: An array of schemas corresponding to the request.
    - `id` string, required: ID of the schema defined as a URN.
    - `name` string, required: Name of the resource type.
    - `description` string, required: Description of the resource type.
    - `attributes` object[], required: List of attributes supported for this schema.
      - `name` string, required: The attribute's name.
      - `type` 'string' | 'boolean' | 'decimal' | 'integer' | 'dateTime' | 'reference' | 'complex', required: The attribute's type.
      - `subAttributes` object[]: A list of sub-attributes. This is defined only for complex attributes. Each sub-attribute is defined with the same schema as an attribute.
      - `multiValued` boolean, required: Indicator for the attribute's plurality.
      - `description` string, required: The attribute's human-readable description.
      - `required` boolean, required: Indicator for whether the attribute is required.
      - `caseExact` boolean: Indicator for whether the attribute is case-sensitive. This only applies for string attributes.
      - `mutability` 'readOnly' | 'readWrite' | 'immutable' | 'writeOnly', required: Definition of the attribute's mutability.
      - `returned` 'always' | 'never' | 'default' | 'request', required: Definition of when the attribute is returned.
      - `uniqueness` 'none' | 'server' | 'global': Definition of the attribute's uniqueness.
      - `referenceTypes` string[]: The list of types that may be referenced by this attribute. This only applies to attributes of type "reference".
  - `totalResults` integer, 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.
  - `startIndex` integer, required: The 1-based index of the first result in the current set of list results.
  - `itemsPerPage` integer, required: The number of resources returned in a list response page.

## Other responses

- `429`: Rate limit exceeded.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)