openedx / openedx/openedx-authz

Migrate Existing Core Roles and Permissions to Declarative YAML

Open
#411 0 comments 0 reactions 1 assignee View on GitHub

@mariajgrimaldi is already working on this.

Since Sep 2, 2026.

willow
Dominant language
Python
Stars
0
Forks
9
Avg merge
13d 9h
Merged PRs (30d)
9

Description

Description

This task focuses exclusively on translating the existing, built-in Open edX roles and permissions into the new declarative YAML schema for openedx-authz. This step guarantees that the baseline system configuration is accurately modeled in the new format before introducing the Casbin enforcement engine or dynamic REST APIs.

Acceptance Criteria
  • Audit Existing Definitions: Identify and document all default roles, permissions, and groupings currently hardcoded or established in the core system.
  • YAML Translation: Create the corresponding YAML definition files mapping the audited rules directly into the new openedx-authz schema.
  • Metadata Preservation: Ensure all contextual data (like display_name, description, and resource targets) is thoroughly captured in the YAML structure so it isn't lost during the migration.
  • Schema Compliance: Validate that the newly created YAML files strictly adhere to the expected format and can be successfully parsed by the Loader (implemented in Issue 2.1).
Concrete Deliverable

A completed set of YAML files committed to the core module that fully represents the current, legacy authorization state, serving as the static source of truth for the new system.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.