Skip to main content

Update Source Schema (Partial)

PATCH /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:

{
    "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

Responses

The Schema was successfully updated.