Sign in
policies

Replace a policy's application list

Replaces the set of applications attached to a policy. The provided list fully overwrites the policy's current applications (it is not additive).

put/api/v1/policies/{policy_id}/applications

Path parameters

policy_idstring uuid required

Headers

Idempotency-Keystring

Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.

Request body

application_idsstring[] required

The complete set of application IDs for this policy.

elevatedboolean

When true, the policy applies only to elevated access requests.

Example request

{
  "application_ids": [
    "7488a646-e31f-11e4-aace-600308960670"
  ],
  "elevated": false
}

Response

Policy

application_idsstring[]

IDs of the applications this policy applies to

default_policyboolean required

Whether this is the default policy

elevatedboolean required

When true, the policy applies only to elevated access requests

idstring uuid required

Policy ID

inserted_atstring date-time
lock_versioninteger

Optimistic lock version

titlestring required

Policy title

updated_atstring date-time

Example response

{
  "application_ids": [
    "8599b757-f42a-22f5-bbdf-711419071781"
  ],
  "default_policy": false,
  "elevated": false,
  "id": "7488a646-e31f-11e4-aace-600308960670",
  "inserted_at": "2023-01-01T00:00:00Z",
  "lock_version": 1,
  "title": "Engineering manager approval",
  "updated_at": "2023-01-01T00:00:00Z"
}

Changes

Changed in 1 of the 3 revisions of this API.11

  • 6f2cb0585bbe11See the full diff
    • ▲

      for the path request parameter policy_id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added