BulkUser

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BulkUser",
  "title": "BulkUser",
  "type": "object",
  "required": [
    "schemas",
    "failOnErrors",
    "operations"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
      },
      "description": "Input JSON schemas."
    },
    "failOnErrors": {
      "type": "number",
      "example": 99,
      "description": "An integer specifying the maximum number of errors that the service provider will accept before the operation is terminated and an error response is returned."
    },
    "operations": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "method",
          "path"
        ],
        "properties": {
          "method": {
            "type": "string",
            "enum": [
              "POST",
              "PATCH",
              "DELETE"
            ],
            "description": "The HTTP method of the current operation."
          },
          "path": {
            "type": "string",
            "example": "/Users/2819c223-7f76-453a-919d-413861904646",
            "description": "The resource's relative path. If the method is POST, the value must specify a resource type endpoint, for example `/Users` or `/Groups`. All other method values must specify the path to a specific resource."
          },
          "data": {
            "type": "string",
            "example": "JSON text",
            "description": "The Resource JSON data as it appears for a single POST or PATCH resource operation."
          },
          "bulkId": {
            "type": "string",
            "example": "ytrewq",
            "description": "The transient identifier of a newly created resource, unique within a bulk request and created by the client."
          }
        }
      },
      "description": "Contains a list of bulk operations for POST/PATCH/DELETE operations."
    }
  }
}