List Permissions

Lists all permissions (roles) in the organization.

GET /permissions

List Permissions

cURL

curl --request GET \
  --url https://api.dfns.io/permissions \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "pm-37vj4-jkr4l-lc9945spfftkne57",
      "name": "<string>",
      "operations": [
        "<string>"
      ],
      "status": "Active",
      "isImmutable": true,
      "isArchived": true,
      "dateCreated": "2023-04-14T20:41:28.715Z",
      "dateUpdated": "2023-04-14T20:41:28.715Z",
      "pendingChangeRequest": {
        "id": "cr-6uunn-bm6ja-f6rmod5kqrk5rbel",
        "requester": {
          "userId": "<string>",
          "tokenId": "<string>",
          "appId": "<string>"
        },
        "status": "Applied",
        "entityId": "<string>",
        "dateCreated": "2023-04-14T20:41:28.715Z",
        "kind": "Permission",
        "operationKind": "Update",
        "body": {
          "id": "pm-37vj4-jkr4l-lc9945spfftkne57",
          "name": "<string>",
          "status": "Active",
          "operations": [
            "<string>"
          ],
          "isImmutable": true,
          "isArchived": true
        },
        "dateResolved": "2023-04-14T20:41:28.715Z",
        "approvalId": "ap-2a9in-tt2a1-983lho480p35ejd0"
      }
    }
  ],
  "nextPageToken": "<string>"
}

Authentication

✅ Organization User (CustomerEmployee)
✅ Delegated User (EndUser)
✅ Service Account

Required Permissions

Permissions:Read: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Query Parameters

limit · integer · default: 50

Maximum number of items to return.

Required range: 1 <= x <= 500

paginationToken · string

Opaque token used to retrieve the next page. Returned as nextPageToken from the previous request.

Minimum string length: 1

Response

200 - application/json

Success

items · object[] · required

Current page items.

Show child attributes

nextPageToken · string

token to use as paginationToken to request the next page.