Skip to main content

Update Source Schema (Partial)​

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
}
Path Parameters
  • sourceId string required

    The Source id.

    Example: 2c9180835d191a86015d28455b4a2329
  • schemaId string required

    The Schema id.

    Example: 2c9180835d191a86015d28455b4a2329
Request Body array required

The JSONPatch payload used to update the schema.

  • op string required

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

  • path string required

    A string JSON Pointer representing the target path to an element to be affected by the operation

  • value object

    The value to be used for the operation, required for "add" and "replace" operations

    anyOf
  • string
Responses

The Schema was successfully updated.

Schema
  • id string

    The id of the Schema.

  • name string

    The name of the Schema.

  • nativeObjectType string

    The name of the object type on the native system that the schema represents.

  • identityAttribute string

    The name of the attribute used to calculate the unique identifier for an object in the schema.

  • displayAttribute string

    The name of the attribute used to calculate the display value for an object in the schema.

  • hierarchyAttribute string

    The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas.

  • includePermissions boolean

    Flag indicating whether or not the include permissions with the object data when aggregating the schema.

  • features string[]

    Possible values: [AUTHENTICATE, COMPOSITE, DIRECT_PERMISSIONS, DISCOVER_SCHEMA, ENABLE, MANAGER_LOOKUP, NO_RANDOM_ACCESS, PROXY, SEARCH, TEMPLATE, UNLOCK, UNSTRUCTURED_TARGETS, SHAREPOINT_TARGET, PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, PASSWORD, CURRENT_PASSWORD, ACCOUNT_ONLY_REQUEST, ADDITIONAL_ACCOUNT_REQUEST, NO_AGGREGATION, GROUPS_HAVE_MEMBERS, NO_PERMISSIONS_PROVISIONING, NO_GROUP_PERMISSIONS_PROVISIONING, NO_UNSTRUCTURED_TARGETS_PROVISIONING, NO_DIRECT_PERMISSIONS_PROVISIONING]

    The features that the schema supports.

  • configuration object

    Holds any extra configuration data that the schema may require.

  • attributes object[]

    The attribute definitions which form the schema.

  • name string

    The name of the attribute.

  • type string

    Possible values: [STRING, LONG, INT, BOOLEAN]

    The underlying type of the value which an AttributeDefinition represents.

  • schema object

    A reference to the schema on the source to the attribute values map to.

  • type string

    Possible values: [CONNECTOR_SCHEMA]

    The type of object being referenced

  • id string

    The object ID this reference applies to.

  • name string

    The human-readable display name of the object.

  • description string

    A human-readable description of the attribute.

  • isMulti boolean

    Flag indicating whether or not the attribute is multi-valued.

  • isEntitlement boolean

    Flag indicating whether or not the attribute is an entitlement.

  • isGroup boolean

    Flag indicating whether or not the attribute represents a group. This can only be true if isEntitlement is also true and there is a schema defined for the attribute..

  • created date-time

    The date the Schema was created.

  • modified date-time

    The date the Schema was last modified.

Loading...