> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # 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 `-editor-role` holds, which can span more permissions than `product` returns here. Read it from `GET /v1/partners/ceiling?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. ## OpenAPI ````yaml /en/openapi/v3-current/AM-identity.yaml get /v1/permissions openapi: 3.1.0 info: contact: name: Lerian Studio url: https://lerian.studio description: OpenAPI 3.1 surface for the Access Manager identity component. license: name: Lerian Studio General License title: Plugin Access Manager — Identity API version: v1 servers: - url: https://identity.sandbox.lerian.net security: [] tags: - description: >- M2M-only: each plugin declares its own permissions, roles and M2M contract, and the server reconciles them. name: Declarations - description: >- A tenant administrator's customers. Each partner holds what its credentials may DO (permissions, per product) and WHERE they may do it (scope, per product and dimension); an M2M application attached to one is confined to that intersection. Administrator-only: authorized on the "partners" resource, and every route resolves the owning organization from the caller's token. name: Partners paths: /v1/permissions: get: tags: - Permissions summary: List Permissions description: >- 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 `-editor-role` holds, which can span more permissions than `product` returns here. Read it from `GET /v1/partners/ceiling?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. operationId: listPermissions parameters: - description: Page number. explode: false in: query name: page schema: default: 1 description: Page number. examples: - 1 format: int64 type: integer - description: Items per page. explode: false in: query name: limit schema: default: 10 description: Items per page. examples: - 10 format: int64 type: integer - description: Filter by name (case-insensitive substring). explode: false in: query name: name schema: description: Filter by name (case-insensitive substring). type: string - description: Filter by the resource the permission governs, e.g. accounts. explode: false in: query name: resource schema: description: Filter by the resource the permission governs, e.g. accounts. type: string - description: Filter by the product that declared the permission, e.g. midaz. explode: false in: query name: product schema: description: Filter by the product that declared the permission, e.g. midaz. type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionPagination' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Not Found '422': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity '500': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Internal Server Error '503': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Service Unavailable security: - BearerAuth: [] components: schemas: PermissionPagination: additionalProperties: false properties: items: description: The page of permissions. items: $ref: '#/components/schemas/PermissionResponse' type: array limit: description: The page size that was applied. examples: - 10 format: int64 type: integer page: description: The 1-based page this response corresponds to. examples: - 1 format: int64 type: integer total: description: Total number of permissions, across all pages. examples: - 10 format: int64 type: integer type: object HTTPError: additionalProperties: false properties: code: type: string entityType: type: string err: {} message: type: string title: type: string type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object PermissionResponse: additionalProperties: false properties: actions: items: type: string type: array effect: examples: - allow type: string groups: items: type: string type: array id: examples: - midaz-editor-permission type: string isEnabled: examples: - true type: boolean name: examples: - Midaz Editor Permission type: string resources: items: type: string type: array roles: items: type: string type: array users: items: type: string type: array type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.