docs: define the static authorization schema by mariajgrimaldi · Pull Request #421 · openedx/openedx-authz

mariajgrimaldi · 2026-08-27T19:06:48Z

Description

Static roles, permissions, and their display information are currently spread across Python, Casbin policy files, and frontend code. As a result, an application that adds a role or permission must update several representations and may also need changes in openedx-authz and the frontend.

This ADR defines one versioned YAML schema for static authorization definitions. Applications can declare permissions, categories, roles, role extensions, scopes, and UI metadata with stable identifiers, while deployment compiles those definitions into the rows Casbin needs.

Merge checklist:
Check off if complete or not applicable:

Version bumped
Changelog record added
Documentation updated (not only docstrings)
Fixup commits are squashed away
Unit tests added/updated
Manual testing instructions provided
Noted any: Concerns, dependencies, migration issues, deadlines, tickets

openedx-webhooks · 2026-08-27T19:06:54Z

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

rodmgwgu

Looking good, just added a couple of points for discussion. Thanks!

rodmgwgu · 2026-08-28T21:40:41Z

+
+   permissions:
+     - namespace: courses
+       name: view_course


Should we specify a naming convention for namespaces, names and permission_categories id? Like ascii lower snake case only?

YES!

I'm working on a reference file

Here it is, I think we could handle the details there once we settle on this ADR: #431

rodmgwgu · 2026-08-28T21:45:18Z

+       permissions:
+         - courses.view_course
+
+   role_extensions:


Good idea, I like it.

rodmgwgu · 2026-08-28T21:54:23Z

+* invalid YAML, unknown fields, missing required fields, and values with the wrong type;
+* unsupported schema versions;
+* IDs that contain uppercase letters or unsupported punctuation;
+* icon names that are unavailable from ``@openedx/paragon/icons``; and


How would we handle possible future changes to the paragon icons? Like naming changes or icon removals?

I think it'd be the same as any consumer of paragon icons (MFEs, extensions and so on) they should follow a deprecation process we'd have to be attentive of

rodmgwgu · 2026-08-28T21:55:00Z

+
+* invalid YAML, unknown fields, missing required fields, and values with the wrong type;
+* unsupported schema versions;
+* IDs that contain uppercase letters or unsupported punctuation;


Should we enforce also snake case naming convention?

BryanttV

Thanks for this @mariajgrimaldi!

BryanttV · 2026-08-31T15:02:39Z

+Decision
+********
+
+#. Schema format and boundary


The automatic numbering isn't working, I'm not sure why.

Mmm others ADRs might being affected by this, I'll look into it later

BryanttV · 2026-08-31T15:03:39Z

+=============================
+
+A permission contains:
+


Should the permissions schema also have a version and priority?

I'd have to look into this in more detail to weigh between the two options. Here's a brain dump:

Versioning I think should be the entire file, I don't think we should individually version each permission since I don't think they would change much. Also the configuration marks the current status of the authorization system, so I think they belong to the file itself

Priority would be mainly for extension patches so we know how to resolve between them. For example, if two extension patches modify the same role and one adds a permission while another removes it, priority would determine which change takes effect.

What kind of use cases can we solve by adding priority to permissions themselves?

BryanttV · 2026-08-31T15:05:07Z

+* ``namespace`` and ``name``, which form the stable identifier used by application checks, such as ``courses.view_course``;
+* the scope namespaces where it can apply;
+* a normalized permission category; and
+* ``display_name``, ``description``, and an optional Paragon icon name.


If the Paragon icon is optional, what would be shown by default? Is there currently an easy way to validate if a Paragon icon exists? Since it is mentioned as part of the initial validation.

I think we can make some kind of request to render it (not sure how easy or out-of-the-box). I was thinking we could do a simple check for the name following paragon conventions. What do you think?

BryanttV · 2026-08-31T15:05:34Z

+#. Roles and role extensions
+============================
+
+A role contains a stable identifier, display name, description, supported scope namespaces, and a list of complete permission identifiers. When an application needs to change an existing role, it uses ``role_extensions``. An extension may add or remove permissions and may replace the role's display name or description.


Can we clearly define the properties that role_extensions accepts?

I opened a different ADR for this: #430

Excellent! Could we include a reference to that ADR here?

BryanttV · 2026-08-31T15:07:49Z

+
+   schema_version: "1.0"
+   priority: 100
+


Is it possible to explain a bit about how priority would work? Would there be a convention or something similar? What should happen if two plugins define the same priority?

I think I do it in the validation and conflicts section, let me know if it's not clear enough: https://github.com/openedx/openedx-authz/pull/421/changes#diff-323a833929851b16109620a7eee56dfe642c78e8c26d00a06cc6c08f321182ceR115

BryanttV · 2026-08-31T15:08:20Z

+         - courses.view_course
+
+   role_extensions:
+     - role: course_admin


Can an extension be added to a role that doesn't exist? Or is this included in the initial validation?

Should be included in the validation

Here: https://github.com/openedx/openedx-authz/pull/421/changes#diff-323a833929851b16109620a7eee56dfe642c78e8c26d00a06cc6c08f321182ceR113

BryanttV · 2026-08-31T15:09:12Z

+Python constants and role mappings
+==================================
+
+Definitions would remain split across backend and frontend code. Applications would also need to change ``openedx-authz`` to add definitions they own.


What happens to the current role and permission definitions in the Python modules? Will we keep using them? If I want to create a new permission, do I have to add it to the YAML and the Python constants file? Or will we do something different?

We'd need to entirely migrate to a configuration file to avoid having definitions scattered across multiple places

I made some changes: 917b782

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 27, 2026

openedx-webhooks added this to Contributions Aug 27, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Aug 27, 2026

mariajgrimaldi linked an issue Aug 27, 2026 that may be closed by this pull request

1. Role and permission definition ADR #409

Open

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Aug 27, 2026

rodmgwgu reviewed Aug 28, 2026

View reviewed changes

BryanttV requested changes Aug 31, 2026

View reviewed changes

docs: define the static authorization schema

ff64cae

mariajgrimaldi force-pushed the MJG/authz-schema/configuration branch from be47fea to ff64cae Compare September 1, 2026 16:03

mariajgrimaldi added 4 commits September 1, 2026 18:07

docs: move authorization schema reference to its own PR

78a973f

docs: clarify Paragon icon validation

932025f

docs: clarify schema migration and extension validation

917b782

docs: render decision section numbers

342a6c3

mariajgrimaldi requested review from BryanttV and rodmgwgu September 1, 2026 17:18

Uh oh!

Conversation

mariajgrimaldi commented Aug 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

openedx-webhooks commented Aug 27, 2026

Uh oh!

rodmgwgu left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BryanttV left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mariajgrimaldi Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mariajgrimaldi commented Aug 27, 2026 •

edited

Loading

mariajgrimaldi Sep 1, 2026 •

edited

Loading

mariajgrimaldi Sep 1, 2026 •

edited

Loading

mariajgrimaldi Sep 1, 2026 •

edited

Loading