SCIM Users

APIs.ioEngineeringPlatform

Properties

Name Type Description
Resources array A list of user resources.
itemsPerPage number The number of items per response page.
schemas array
startIndex number The index entry by which the returned results begin.
totalResults number The total number of results found.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-scimuserresources-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/scimUserResources",
  "title": "SCIM Users",
  "type": "object",
  "properties": {
    "Resources": {
      "type": "array",
      "description": "A list of user resources.",
      "items": {
        "$ref": "#/components/schemas/scimUserResource"
      }
    },
    "itemsPerPage": {
      "type": "number",
      "description": "The number of items per response page.",
      "example": 2
    },
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).",
        "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      }
    },
    "startIndex": {
      "type": "number",
      "description": "The index entry by which the returned results begin.",
      "example": 1
    },
    "totalResults": {
      "type": "number",
      "description": "The total number of results found.",
      "example": 1000
    }
  }
}