Archive Policy

DELETE /v2/policies/{policyId}

Archives a policy.

• User action signature required. See User Action Signing for more information.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Required Permissions

Name	Conditions
Policies:Archive	Always Required

Path parameters

Path parameter	Description
policyID	Unique identifier of the Policy. ex. plc-1f04s-lqc9q-xxxxxxxxxxxxxxxx

RResponse

200 - no approval required

Same as Create Policy response, except policy status is "Archived"

202 - approval required

In the case when an approval is first required before the policy can actually be modified, a 202 status code is returned, and the object returned is a "Policy change request", which contains an approvalId. You can use the approvalId to fetch the right approval to be fulfilled before this change request actually executes.

// policy change request object
{
  "id": "cr-...",
  "kind": "Policy",
  "operationKind": "Update",
  "status": "Pending",
  "requester": { "userId": "us-..." },
  "entityId": "plc-...",
  "approvalId": "ap-...",
  "dateCreated": "2023-12-22T20:57:55.814Z",
  "body": {
    ... // the full body passed in the request
  }
}