latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Permission

List all permissions for a tenant

Returns a paginated list of all permission records scoped to the tenant identified by the tenant-id header. Use this endpoint to inspect the full permission catalog before assigning permissions to roles; for a single known permission, use GET /permissions/{id} instead.

Preconditions: the caller must be authenticated and hold the READ_PERMISSION permission for the tenant.

Pagination is offset-based: supply page (0-based, defaults to 0) and size (defaults to 100). The response contains data (the permission objects for this page), totalCount, hasNext, and hasPrevious. Note: the createdAt and updatedAt fields on each permission are always null in the current implementation, and the envelope's page/size fields are not populated by this endpoint.

get/permissions

Query parameters

pageinteger

Zero-based page number for offset pagination. Defaults to 0 when omitted. Maximum value is not documented.

sizeinteger

Number of permission records to return per page. Defaults to 100 when omitted. Maximum value is not documented.

Headers

tenant-idstring required

Tenant identifier that scopes the request to a specific tenant's permission catalog.

Response

The requested page of permission records for this tenant, wrapped in a pagination envelope (data, totalCount, hasNext, hasPrevious). The createdAt and updatedAt fields on each permission are always null in the current implementation.

totalCountinteger

Total number of permission records across all pages for this tenant, not just the current page.

pageinteger

Currently always null — this endpoint does not populate a page number in the envelope.

sizeinteger

Currently always null — this endpoint does not populate a page size in the envelope.

hasNextboolean

Whether a subsequent page of results is available, based on the presence of a next-page link from the underlying data service.

hasPreviousboolean

Whether a preceding page of results is available, based on the presence of a previous-page link from the underlying data service.

Example response

{
  "data": [
    {
      "id": "perm-123-456-789",
      "resource": "user",
      "action": "read",
      "description": "Allows reading user profiles",
      "createdAt": "2022-03-10T12:15:50-04:00",
      "updatedAt": "2022-03-10T12:15:50-04:00"
    }
  ]
}