Archive Permission

PUT /permissions/{permissionId}/archive

Archives or unarchives a permission, depending on the body of the request. Response either returns the updated permission (success) or the reason why it was not possible to execute the operation (failure).

Required Permissions

Name
Conditions

Permissions:Archive

Always Required

Parameters

Path parameters

Path parameter
Description

permissionId

Unique identifier of the permission. Permission IDs look like this: pm-orange-apple-2b17a80613

Request body

In the request body specify wheter the permission is to be archived or unarchived.

property
Type - Required
Description

isArchived

Boolean - Required

Specify whether to archive or unarchive permission.

Request example

{
  "isArchived": true
}

Response

Response example 200 - no approval required

If successful, a response object of the update permission will be returned:

// permission
{
    "id": "pm-orange-apple-2b17a80613",
    "name": "US",
    "operations": ["Wallets:Read"],
    "status": "Active",
    "isImmutable": false,
    "dateCreated": "2022-10-26T08:30:25.348Z",
    "dateUpdated": "2022-10-26T08:30:25.348Z",
    "isArchived": true
}

Response example 202 - approval required

// permission change request
{
   "id":"cr-...",
   "kind":"Permission",
   "operationKind":"Update",
   "status":"Pending",
   "entityId":"pm-...",
   "dateCreated":"2023-12-22T20:57:55.814Z",
   "dateResolved":"2023-12-22T20:57:55.814Z",
   "requester":{
     "userId":"us-...",
     "tokenId":"to-..."
   },
   "body":{
      "id":"pm-orange-apple-2b17a80613",
      "name":"US",
      "operations":["Wallets:Read"],
      "status":"Active",
      "isImmutable":false,
      "isArchived":true
   },
}

Notes

When a permission is archived, it remains in the database and its permission name cannot be reused.

Last updated