policy

Update an existing policy

patch/v1/org/{orgId}/policy/{policyId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/policy/{policyId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

policyIdstring required

Policy id

Request body

labelstring

human-readable full name of policy

descriptionstring

description of policy

Example request

{
  "label": "View Compensation",
  "description": "This policy allows compensation to be viewed.",
  "rules": [
    {
      "departmentIds": [
        "588f7ee98f138b19220041a7"
      ],
      "filter": "department:engineering and under:me",
      "targets": [
        {
          "personId": "588f7ee98f138b19220041a7"
        }
      ]
    }
  ]
}

Response

policy updated

Changes

No recorded changes to this operation across all 20 revisions of this API.