Removing Custom User Schema Attributes Using PATCH

This section describes the use of PATCH "op":"remove" when removing custom user schema attributes.

Using the Remove Operation With Filters

• In this example, the PATCH "remove" operation is used with filters to remove the "subDivision" attribute.

  PATCH  /Schemas/urn:item:params:scam:schemas:ides:extension:custom:User
  {
      "schemas": [
          "urn:ietf:params:scim:api:messages:2.0:PatchOp"
      ],
      "Operations": [{
              "op": "remove",
              "path": "attributes[name eq \"subDivision\"]"
          }]
  }

• In this example, the PATCH "remove" operation is used with filters to remove all attributes with the "required" property set to "false".

  Patch  /Schemas/urn:item:params:scam:schemas:ides:extension:custom:User
  {
      "schemas": [
          "urn:ietf:params:scim:api:messages:2.0:PatchOp"
      ],
      "Operations": [{
              "op": "remove",
              "path": "attributes[required eq false]"
          }]
  }

Example JSON Response

{
    "name": "CustomUser",
    "description": "Custom User",
    "id": "urn:ietf:params:scim:schemas:idcs:extension:custom:User",
    "idcsResourceTypes": [
        "User"
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ],
    "attributes": [
        {
            "required": true,
            "idcsValuePersisted": true,
            "idcsTargetAttributeName": "I_VC_4K_IFLEX_1",
            "idcsMaxLength": 350,
            "caseExact": true,
            "uniqueness": "none",
            "name": "branchAddress",
            "idcsDisplayName": "Branch Address",
            "type": "string",
            "description": "Branch Office Address",
            "idcsMinLength": 5,
            "multiValued": false,
            "returned": "always",
            "mutability": "readWrite",
            "idcsSearchable": true
        }
    ],
    "meta": {
        "lastModified": "2018-08-15T20:06:53.745Z",
        "resourceType": "TenantSchema",
        "created": "2018-08-15T05:02:13.788Z",
        "location": "https://<tenant-base-url>/admin/v1/TenantSchemas/urn:ietf:params:scim:schemas:idcs:extension:custom:User"
    },
    "idcsLastModifiedBy": {
        "type": "App",
        "display": "admin",
        "$ref": "https://<tenant-base-url>/admin/v1/Apps"
    },
    "idcsCreatedBy": {
        "value": "158d625222f442ef8fcc817593701dd9",
        "type": "App",
        "display": "idcssm",
        "$ref": "https://<tenant-base-url>/admin/v1/Apps/158d625222f442ef8fcc817593701dd9"
    }
}