de.gold.scim.common.request.patch-request.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-common Show documentation
The newest version!
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id": "urn:ietf:params:scim:api:messages:2.0:PatchOp",
  "name": "PatchOp",
  "description": "HTTP PATCH is an OPTIONAL server function that enables clients to update one or more attributes of a SCIM resource using a sequence of operations to \"add\", \"remove\", or \"replace\" values.Clients may discover service provider support for PATCH by querying the service provider configuration ",
  "attributes": [
    {
      "name": "Operations",
      "type": "complex",
      "description": "Defines operations within a bulk job. Each operation corresponds to a single HTTP request against a resource endpoint. REQUIRED.",
      "mutability": "writeOnly",
      "returned": "never",
      "uniqueness": "none",
      "multiValued": true,
      "caseExact": false,
      "required": true,
      "subAttributes": [
        {
          "name": "path",
          "type": "string",
          "description": "The \"path\" attribute value is a String containing an attribute path describing the target of the operation.The \"path\" attribute is OPTIONAL for \"add\" and \"replace\" and is REQUIRED for \"remove\" operations.",
          "mutability": "writeOnly",
          "returned": "never",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": false
        },
        {
          "name": "op",
          "type": "string",
          "description": "Each PATCH operation object MUST have exactly one \"op\" member, whose value indicates the operation to perform and MAY be one of \"add\", \"remove\", or \"replace\"",
          "canonicalValues": [
            "add",
            "remove",
            "replace"
          ],
          "mutability": "writeOnly",
          "returned": "never",
          "uniqueness": "none",
          "multiValued": false,
          "caseExact": false,
          "required": true
        },
        {
          "name": "value",
          "type": "string",
          "description": "the new value of the targeted attribute",
          "mutability": "writeOnly",
          "returned": "never",
          "uniqueness": "none",
          "multiValued": true,
          "caseExact": false,
          "required": true
        }
      ]
    }
  ],
  "meta": {
    "resourceType": "Schema",
    "created": "2019-10-18T14:51:11+02:00",
    "lastModified": "2019-10-18T14:51:11+02:00",
    "location": "/Schemas/PatchOp"
  }
}