Skip to content

feat: split read vs write authz checks for certificates - #39008

Open
wgu-taylor-payne wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:tpayne/view-certificates-permission
Open

feat: split read vs write authz checks for certificates#39008
wgu-taylor-payne wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:tpayne/view-certificates-permission

Conversation

@wgu-taylor-payne

Copy link
Copy Markdown
Contributor

Description

Updates the certificates REST API v1 endpoint to use courses.view_certificates for GET access and courses.manage_certificates for write access. Adds a can_manage flag to the API response so the frontend can conditionally render edit controls.

Previously, the GET handler checked COURSES_MANAGE_CERTIFICATES with LegacyAuthoringPermission.WRITE, which blocked Course Editors and Auditors from viewing certificates entirely. Per the design in openedx/openedx-authz#283 and openedx/openedx-authz#329, users with view access should see the page in read-only mode.

User roles impacted: Course Editor, Course Auditor — can now view (but not edit) certificates when authz is enabled.

Changes:

  • cms/djangoapps/contentstore/rest_api/v1/views/certificates.py: Use VIEW_CERTIFICATES for access gate, add can_manage check
  • cms/djangoapps/contentstore/rest_api/v1/serializers/certificates.py: Add can_manage field
  • Tests: Updated and added tests for staff (can_manage=True), editor/auditor (can_manage=False), and unauthorized (403)

Rollback: Gated behind AUTHZ_COURSE_AUTHORING_FLAG — disabling the flag reverts to legacy behavior.

Supporting information

Testing instructions

  1. Enable AUTHZ_COURSE_AUTHORING_FLAG for a course
  2. Assign a user the course_editor role
  3. GET /api/contentstore/v1/certificates/{course_id} → 200 with can_manage: false
  4. Assign course_staff role → 200 with can_manage: true
  5. User with no role → 403

Deadline

None

@openedx-webhooks 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 20, 2026
@openedx-webhooks

openedx-webhooks commented Aug 20, 2026

Copy link
Copy Markdown

Thanks for the pull request, @wgu-taylor-payne!

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

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 Aug 20, 2026
BryanttV added a commit to eduNEXT/edx-platform that referenced this pull request Aug 20, 2026
@wgu-taylor-payne
wgu-taylor-payne force-pushed the tpayne/view-certificates-permission branch from 3215e24 to cadf7c1 Compare August 21, 2026 18:45
@wgu-taylor-payne
wgu-taylor-payne marked this pull request as ready for review August 21, 2026 18:45
Use COURSES_VIEW_CERTIFICATES for GET access and
COURSES_MANAGE_CERTIFICATES for write access. Add can_manage flag
to the response so the frontend knows whether to render edit controls.
Course Editors and Auditors can now view certificates in read-only mode.

ENG45-714
@wgu-taylor-payne
wgu-taylor-payne force-pushed the tpayne/view-certificates-permission branch from cadf7c1 to 17f1123 Compare August 21, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

Add courses.view_certificates enforcement in openedx-platform

2 participants