Add `hidden` property to permission categories and permissions
Maintainers usually reply within 1 day
@BryanttV is already working on this.
Since Nov 17, 2026.
Assessment
This issue has not been assessed yet.
Description
Description
Static roles already support a hidden flag (ADR 0023) that removes a role from normal discovery and selection interfaces without deleting it or changing permission checks. Permission categories and permissions have no equivalent. Operators and applications cannot keep a permission or category defined in the schema while omitting it from the catalog that UIs consume (for example, one that is deprecated, experimental, or not meant to be assigned directly).
Adding the same flag to categories and permissions lets deployments control what is surfaced in the role/permission catalog while keeping the definitions, existing role grants, and enforcement intact.
Current Behavior
hiddenis only supported on roles ($defs/roleand$defs/role_extensioninauthz-schema-v1.json) and persisted inAuthzRoleDefinition.hidden.permission_categoriesandpermissionsentries in the schema do not accepthidden, andAuthzPermissionCategory/AuthzPermissionDefinitionhave no such column.- The scope-type catalog endpoint (ADR 0028) returns every category and permission used by the requested scope types, regardless of whether they should be exposed.
Expected Behavior
- Categories and permissions accept an optional boolean
hiddenfield in the authorization schema (defaultfalse), with the same semantics as for roles: hidden items are omitted from normal discovery APIs and selection UIs, but are not deleted, do not lose existing role grants, and do not change permission checks. - The compiled schema, source tracking, and database persist the flag, and changing it is reported as an update when applying a schema.
- The role/permission catalog API omits hidden categories and hidden permissions (and does not return a category whose permissions are all hidden).
Acceptance Criteria
-
authz-schema-v1.jsonaccepts an optional booleanhidden(defaultfalse) on category and permission definitions, and the schema reference docs are regenerated. -
AuthzPermissionCategoryandAuthzPermissionDefinitionstorehidden, with a migration that defaults existing rows tofalse. - The schema compiler, storage, and
load_authz_schema/ apply reporting persist the flag and report a changedhiddenvalue as an update. - The catalog endpoint excludes hidden categories and hidden permissions, and the API contract is documented.
- Hiding a permission or category does not remove existing role-permission relationships and does not alter authorization checks.
- Behavior for a role that references a hidden permission is defined and covered by a test.
- Tests cover schema validation, persistence, clearing the flag, and catalog filtering.
- Documentation (ADR or ADR update, schema reference, CHANGELOG) is updated.
Related: ADR 0023 (hidden roles), ADR 0025 (source tracking), ADR 0028 (role catalog API contract).
- Dominant language
- Python
- Stars
- 0
- Forks
- 10
- Avg merge
- 5d 11h
- Merged PRs (30d)
- 25
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from openedx/openedx-authz
-
Add a course permission check to ContainerChildrenViewPossibly taken @BryanttV claimed this 7 days ago. Openwillow
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
openedx/openedx-authz#604 · 1 assignee ·
Maintainers usually reply within 1 day
-
Allow Course Editors to import YouTube transcripts and surface errorsPossibly taken @efortish claimed this 7 days ago. Openwillow
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
openedx/openedx-authz#597 · 1 assignee ·
Maintainers usually reply within 1 day
-
willow
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
openedx/openedx-authz#579 ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
openedx/openedx-authz#631 ·
Maintainers usually reply within 1 day
-
Run performance tests on the Willow RBAC authorization flows in openedx-authz and openedx-platformOpen
Difficulty 5/5 Over a week Newbie friendliness 35/100
openedx/openedx-authz#630 ·
Maintainers usually reply within 1 day
All issues in openedx/openedx-authz
Similar issues
-
opensubtitlescom: provider rejects pt-PT even though its own converter maps itPossibly taken @paulo-0308 claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Diaoul/subliminal#1405 ·
-
Internal ErrorOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
frappe/frappe_docker#2071 ·
Maintainers usually reply within 1 day
-
🐛 Bug Report: OpenAI Responses: with_raw_response.create() raises when the body can't be parsed, though the uninstrumented call returnsPossibly taken A pull request linked to this issue is open or already merged. Openbug python
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
traceloop/openllmetry#4717 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
The-Pocket/PocketFlow#161 ·
-
comp/desktop P2 type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NousResearch/hermes-agent#157702 ·
Maintainers usually reply within 1 day