Skip to main content

Patch SOD policy by ID

PATCH 
/sod-policies/:id

Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the JSON Patch standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception.

Request​

Path Parameters

    id stringrequired

    The ID of the SOD policy being modified.

    Example: 2c918083-5d19-1a86-015d-28455b4a2329

Body

array

required

A list of SOD Policy update operations according to the JSON Patch standard.

The following fields are patchable:

  • name

  • description

  • ownerRef

  • externalPolicyReference

  • compensatingControls

  • correctionAdvice

  • state

  • tags

  • violationOwnerAssignmentConfig

  • scheduled

  • conflictingAccessCriteria

  • Array [

    • op stringrequired

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

    The operation to be performed

    path stringrequired

    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

    oneOf

    string

  • ]

Responses​

Indicates the PATCH operation succeeded, and returns the SOD policy's new representation.

Schema

    id string

    Policy id

    name string

    Policy Business Name

    created date-time

    The time when this SOD policy is created.

    modified date-time

    The time when this SOD policy is modified.

    description stringnullable

    Optional description of the SOD policy

    ownerRef

    object

    The owner of the SOD policy.

    type string

    Possible values: [IDENTITY, GOVERNANCE_GROUP]

    Owner type.

    id string

    Owner's ID.

    name string

    Owner's name.

    externalPolicyReference stringnullable

    Optional External Policy Reference

    policyQuery string

    Search query of the SOD policy

    compensatingControls stringnullable

    Optional compensating controls(Mitigating Controls)

    correctionAdvice stringnullable

    Optional correction advice

    state string

    Possible values: [ENFORCED, NOT_ENFORCED]

    whether the policy is enforced or not

    tags string[]

    tags for this policy object

    creatorId string

    Policy's creator ID

    modifierId stringnullable

    Policy's modifier ID

    violationOwnerAssignmentConfig

    object

    nullable

    assignmentRule stringnullable

    Possible values: [MANAGER, STATIC, null]

    Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity

    ownerRef

    object

    nullable

    The owner of the violation assignment config.

    type string

    Possible values: [IDENTITY, GOVERNANCE_GROUP, MANAGER, null]

    Owner type.

    id string

    Owner's ID.

    name string

    Owner's name.

    scheduled boolean

    defines whether a policy has been scheduled or not

    type string

    Possible values: [GENERAL, CONFLICTING_ACCESS_BASED]

    Default value: GENERAL

    whether a policy is query based or conflicting access based

    conflictingAccessCriteria

    object

    leftCriteria

    object

    name string

    Business name for the access construct list

    criteriaList

    object[]

    Possible values: >= 1, <= 50

    List of criteria. There is a min of 1 and max of 50 items in the list.

  • Array [

    • type string

    Possible values: [ENTITLEMENT]

    Type of the propery to which this reference applies to

    id string

    ID of the object to which this reference applies to

    name string

    Human-readable display name of the object to which this reference applies to

  • ]

    • rightCriteria

    object

    name string

    Business name for the access construct list

    criteriaList

    object[]

    Possible values: >= 1, <= 50

    List of criteria. There is a min of 1 and max of 50 items in the list.

  • Array [

    • type string

    Possible values: [ENTITLEMENT]

    Type of the propery to which this reference applies to

    id string

    ID of the object to which this reference applies to

    name string

    Human-readable display name of the object to which this reference applies to

  • ]

Loading...