Skip to main content

Get API permission catalog

GET 
/permissions/catalog

Returns the supported API permission role types, grouped by permission group, with the scoped permission names and descriptions in each group. Use this catalog when creating API keys or mapping user roles to permissions.

Predefined role types contain their effective permissions, including permissions inherited from other operation categories. CUSTOM contains all available scoped permissions as selectable options; it does not automatically grant them. Deprecated umbrella permissions are excluded from the permission lists, and empty groups are omitted.

The catalog is available to authenticated callers without a site-specific API permission. It describes supported grants rather than the caller's current permissions or authority to assign those grants. No siteId is required.

Responses​

API permission catalog

Response Headers
    Access-Control-Allow-Origin
    Access-Control-Allow-Methods
    Access-Control-Allow-Headers