List Permissions

Returns the catalog of permissions this deployment knows about, one page at a time.

A permission is the smallest unit of access — a resource and the verbs allowed on it. You do not create them: each product DECLARES its own through PUT /v1/declarations/{slug} and the server reconciles the catalog, which is why this family is read-only.

Read this to find out what you can put INTO a role. product narrows to one product’s declarations and resource to one collection; name is the substring match.

This is not the list of what a partner can be granted in a product: that is everything your organization’s <product>-editor-role holds, which can span more permissions than product returns here. Read it from GET /v1/partners/ceiling?product=<product>.

Read-only: nothing changes.

Failures:

• 400 IDE-0018 — limit is above the deployment’s maximum (100 by default).
• 400 IDE-0019 — page is below 1.
• 400 IDE-1041 — product is not a known catalog slug. The message lists the catalog. A whitespace-only product is treated as absent instead.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

GET /v1/permissions

List Permissions

cURL

curl --request GET \
  --url https://identity.sandbox.lerian.net/v1/permissions \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "actions": [
        "<string>"
      ],
      "effect": "allow",
      "groups": [
        "<string>"
      ],
      "id": "midaz-editor-permission",
      "isEnabled": true,
      "name": "Midaz Editor Permission",
      "resources": [
        "<string>"
      ],
      "roles": [
        "<string>"
      ],
      "users": [
        "<string>"
      ]
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 10
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Query Parameters

page · integer<int64> · default: 1

Page number.

Example:

1

limit · integer<int64> · default: 10

Items per page.

Example:

10

name · string

Filter by name (case-insensitive substring).

resource · string

Filter by the resource the permission governs, e.g. accounts.

product · string

Filter by the product that declared the permission, e.g. midaz.

Response

200

application/json

OK

items · object[]

The page of permissions.

Show child attributes

limit · integer<int64>

The page size that was applied.

Example:

10

page · integer<int64>

The 1-based page this response corresponds to.

Example:

1

total · integer<int64>

Total number of permissions, across all pages.

Example:

10