Skip to content

feat: introduce authz_permission_required decorator#38156

Open
dwong2708 wants to merge 7 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/new-permissions-checklists
Open

feat: introduce authz_permission_required decorator#38156
dwong2708 wants to merge 7 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/new-permissions-checklists

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Mar 11, 2026

Resolves openedx/openedx-authz#200

Description

This PR introduces a new decorator to enforce permissions using the new AuthZ system and applies it to the Course Quality and Course Validations endpoints.

The decorator centralizes the authorization logic for course authoring APIs by checking permissions through the AuthZ service, with an optional fallback to the legacy permission system during the migration period.

As part of implementing the new permissions for the Checklist section of the course, the decorator is now applied to the following endpoints:

  • Course Quality API
  • Course Validations API

This ensures that access to checklist-related functionality is properly controlled by the new permission model.

Changes

  • Added a new authz_permission_required decorator to enforce AuthZ permissions.
  • Implemented support for extracting the course key from different view argument patterns (function views, class-based views, and DRF routes).
  • Applied the decorator to:
    • Course Quality endpoint
    • Course Validations endpoint
  • Maintained optional fallback to the legacy permission check during the transition period.

Testing

  • Added tests for the decorator behavior.
  • Verified that:
    • Authorized users can access the endpoints.
    • Unauthorized users receive a 403 response.
    • Legacy permission fallback works as expected.

Context

This change is part of the work to support RBAC/AuthZ permissions for the Checklist section in course authoring.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 11, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Mar 11, 2026

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Mar 11, 2026
@dwong2708 dwong2708 force-pushed the dwong2708/new-permissions-checklists branch from bce4a4a to 1c4fe82 Compare March 12, 2026 03:33
@dwong2708 dwong2708 marked this pull request as ready for review March 12, 2026 16:47
Copy link
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just one logic change and some minor comments.

@dwong2708 dwong2708 force-pushed the dwong2708/new-permissions-checklists branch from b4cdb3f to 582c8bc Compare March 12, 2026 18:50
@dwong2708 dwong2708 requested a review from rodmgwgu March 12, 2026 18:54
Copy link
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! Tested in my local and works as expected.

@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Mar 12, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

Task - RBAC AuthZ - Implement new permissions for checklists

4 participants