Add `hidden` property to permission categories and permissions
Los mantenedores suelen responder en 1 día
@BryanttV ya está trabajando en esto.
Desde el 17/11/2026.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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).
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 10
- Merge medio
- 5 d 11 h
- PR fusionados (30 d)
- 25
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openedx/openedx-authz
-
Add a course permission check to ContainerChildrenViewPosiblemente ocupada @BryanttV la tomó hace 7 días. Abiertowillow
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
openedx/openedx-authz#604 · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Allow Course Editors to import YouTube transcripts and surface errorsPosiblemente ocupada @efortish la tomó hace 7 días. Abiertowillow
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
openedx/openedx-authz#597 · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
willow
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
openedx/openedx-authz#579 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
openedx/openedx-authz#631 ·
Los mantenedores suelen responder en 1 día
-
Run performance tests on the Willow RBAC authorization flows in openedx-authz and openedx-platformAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
openedx/openedx-authz#630 ·
Los mantenedores suelen responder en 1 día
Todos los issues de openedx/openedx-authz
Issues similares
-
CI flake: test-windows times out spawning Node in tests/test_antigravity_node_hooks.py (develop red)Abiertoarea/ci P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 2 días
-
benchmark
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
mozilla-ai/cq#601 ·
Los mantenedores suelen responder en 1 día
-
Bump Python to 3.14 or 3.15Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día