Skip to content

docs: document Enterprise ACL inspection functions - #566

Open
glasstiger wants to merge 5 commits into
mainfrom
ia_active_permissions
Open

glasstiger wants to merge 5 commits into
mainfrom
ia_active_permissions

Conversation

@glasstiger

@glasstiger glasstiger commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Document the Enterprise ACL inspection functions introduced by questdb/questdb-enterprise#1222 and make the Access control functions page a complete reference for all four ACL table functions:

Function What it returns
all_permissions() Available permission names and grantable levels
permissions() Effective permissions for the current or a named entity
active_permissions() Effective permissions across persisted users, groups, and service accounts, including group inheritance
active_grants() Direct grants across those entities, without inherited permissions

The reference now includes an Enterprise marker, formal function grammar, result columns, authorization requirements, limitations, and precise database-, table-, and column-scope semantics. Verified SQL examples and result tables cover:

  • comparing effective permissions with direct grants;
  • finding entities that can read a table or a specific column;
  • preserving group rows when auditing SSO/OIDC access;
  • finding direct grant recipients and entities with the grant option.

Limitations explain access paths not represented directly, including views and assumed service accounts.

Related changes:

  • Consolidate the three SHOW PERMISSIONS headings into one section covering current and named entities, add a result example, and preserve the old #show-permissions-for-current-user and #show-permissions-user deep links.
  • Add inbound links from RBAC, SHOW, GRANT, and REVOKE, plus stable active_permissions and active_grants compatibility anchors.
  • Correct the Enterprise quick start: all_permissions() lists available permissions rather than applied grants.
  • Clarify when LIST USERS, USER DETAILS, or both are required.
  • Add the Access control functions page to the Functions sidebar and documentation changelog.

Dependencies

@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

🚀 Build success!

Latest successful preview: https://preview-566--questdb-documentation.netlify.app/docs/

Commit SHA: d5293d1

📦 Build generates a preview & updates the link on each commit.

@glasstiger glasstiger changed the title docs: document active_permissions() and active_grants() docs: document Enterprise ACL inspection functions Sep 25, 2026
@glasstiger glasstiger added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant