Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Permissions

Update Policy

Updates an existing policy.

The update is a full replacement of the policy's bindings. Any role or resource binding not included in the request body is removed. To make a partial change, fetch the current policy with GET /api/permissions/policies/{id}, modify the relevant bindings, and send the complete object back.

put/api/permissions/policies/{id}

Path parameters

idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

namestring required
organization_idstring uuid nullable

Example request

{
  "name": "Custom",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "policy_actions": [
    {
      "action": "read",
      "role_ids": [
        "248df4b7-aa70-47b8-a036-33ac447e668d"
      ]
    }
  ]
}

Response

OK

Example response

{
  "data": {
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "name": "Policy",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policy_actions": [
      {
        "action": "read",
        "role_ids": [
          "248df4b7-aa70-47b8-a036-33ac447e668d"
        ]
      }
    ]
  }
}