List all schemas

Lists all schemas and their attributes.

get/Schemas

Request

  • Base URL
    https://app.perk.com/api/v2/scim
  • URL
    https://app.perk.com/api/v2/scim/Schemas
  • Auth
    API key in header Authorization

Response

Returns 200 OK and a list of all schema definitions.

schemasstring[]
totalResultsinteger
itemsPerPageinteger
startIndexinteger

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "itemsPerPage": 10,
  "startIndex": 1,
  "Resources": [
    {
      "id": "urn:ietf:params:scim:schemas:core:2.0:User",
      "name": "User",
      "description": "User Account Schema",
      "attributes": [
        {
          "name": "name",
          "type": "complex",
          "description": "The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.",
          "required": true,
          "subAttributes": [
            {
              "name": "familyName",
              "type": "string",
              "description": "The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').",
              "required": true,
              "mutability": "readWrite",
              "returned": "default",
              "uniqueness": "none"
            }
          ],
          "mutability": "readWrite",
          "returned": "default",
          "uniqueness": "none"
        }
      ],
      "meta": {
        "resourceType": "Schema",
        "location": "https://app.perk.com/api/v2/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
      },
      "schemaExtensions": [
        {
          "schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
        }
      ]
    }
  ]
}

Changes

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