Update Source Schema (Partial)

PATCH {{baseUrl}}/sources/:sourceId/schemas/:schemaId

Use this API to selectively update an existing Schema using a JSONPatch payload.

The following schema fields are immutable and cannot be updated:

  • id
  • name
  • created
  • modified

To switch an account attribute to a group entitlement, you need to have the following in place:

  • isEntitlement: true
  • Must define a schema for the group and add it to the source before updating the isGroup flag. For example, here is the group account attribute referencing a schema that defines the group: json { "name": "groups", "type": "STRING", "schema": { "type": "CONNECTOR_SCHEMA", "id": "2c9180887671ff8c01767b4671fc7d60", "name": "group" }, "description": "The groups, roles etc. that reference account group objects", "isMulti": true, "isEntitlement": true, "isGroup": true }

Request Body

{"0"=>{"op"=>"replace", "path"=>"/displayAttribute", "value"=>{"new-display-attribute"=>nil}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"id":"2c9180835d191a86015d28455b4a2329","name":"account","nativeObjectType":"User","identityAttribute":"sAMAccountName","displayAttribute":"distinguishedName","hierarchyAttribute":"memberOf","includePermissions":false,"features":["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"],"configuration":{"groupMemberAttribute":"member"},"attributes":[{"name":"sAMAccountName","type":"STRING","isMultiValued":false,"isEntitlement":false,"isGroup":false},{"name":"memberOf","type":"STRING","schema":{"type":"CONNECTOR_SCHEMA","name":"group"},"description":"Group membership","isMultiValued":true,"isEntitlement":true,"isGroup":true}],"created":"2019-12-24T22:32:58.104Z","modified":"2019-12-31T20:22:28.104Z"}