Skip to main content

Patch a specified Entitlement

This API updates an existing Entitlement using JSON Patch syntax.

The following fields are patchable: requestable, privileged, segments

A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.

Path Parameters
  • id string required

    ID of the Entitlement to patch

Request Body array
  • 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


  • string

Responds with the Entitlement as updated.

  • id string

    The entitlement id

  • name string

    The entitlement name

  • attribute string

    The entitlement attribute name

  • value string

    The value of the entitlement

  • sourceSchemaObjectType string

    The object type of the entitlement from the source schema

  • description string

    The description of the entitlement

  • privileged boolean

    True if the entitlement is privileged

  • cloudGoverned boolean

    True if the entitlement is cloud governed

  • created date-time

    Time when the entitlement was created

  • modified date-time

    Time when the entitlement was last modified

  • source object
  • id string

    The source ID

  • type string

    The source type, will always be "SOURCE"

  • name string

    The source name

  • attributes object

    A map of free-form key-value pairs from the source system

  • segments string[]

    List of IDs of segments, if any, to which this Entitlement is assigned.

  • directPermissions object[]
  • rights string[]

    All the rights (e.g. actions) that this permission allows on the target

  • target string

    The target the permission would grants rights on.