Skip to content
StraventaDocs
Now in Sandbox.

List registered permissions

GET
/v1/admin/permissions

Returns the full catalogue of registered platform and tenant permissions. Read-only; no pagination.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT Bearer access token. Clock skew tolerance is ±60 seconds.

In: header

Query Parameters

sort?string

Column to order the permission catalogue by. Defaults to service ascending. status orders by the deprecated flag. The per-role grant columns are not sortable and return 400 invalid_sort_key.

Value in"service" | "key" | "description" | "status"
order?string

Sort direction. Ignored unless sort is supplied; an unrecognised value returns 400 invalid_sort_order.

Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

curl -X GET https://sandbox.505pay.link/v1/admin/permissions \  -H "Authorization: Bearer $TOKEN" \  -H "Content-Type: application/json"
{
  "permissions": [
    {
      "id": "platform.user.read",
      "service": "platform",
      "key": "platform.user.read",
      "description": "Read user records across tenants",
      "deprecated": false,
      "granted_by_roles": [
        {
          "id": "018f1a2b-0001-7000-8000-000000000010",
          "key": "platform_admin",
          "name": "Platform Admin"
        }
      ]
    }
  ]
}
{
  "error": "unauthenticated",
  "message": "missing or invalid bearer token",
  "request_id": "req_01abc123"
}
{
  "error": "permission_denied",
  "message": "caller does not hold the required permission",
  "request_id": "req_01abc124"
}
{
  "error": "rate_limited",
  "message": "too many requests",
  "request_id": "req_01abc127"
}

Was this page helpful?