Skip to content

feat: split read vs write authz checks for group configurations - #39010

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

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

Conversation

@wgu-taylor-payne

Copy link
Copy Markdown
Contributor

Description

Updates group configuration endpoints to use courses.view_group_configurations for GET access and courses.manage_group_configurations for write access. Adds a can_manage flag to the REST API v1 response so the frontend can conditionally render edit controls.

Previously, both the REST API v1 view and the legacy handler used COURSES_MANAGE_GROUP_CONFIGURATIONS for all access including reads. This blocked Course Auditors from viewing group configurations entirely. Per the design in openedx/openedx-authz#283, auditors should see the page in read-only mode.

User roles impacted: Course Auditor — can now view (but not edit) group configurations. Course Editor retains full access (has both view and manage permissions).

Changes:

  • cms/djangoapps/contentstore/rest_api/v1/views/group_configurations.py: Use VIEW_GROUP_CONFIGURATIONS in decorator, add can_manage check
  • cms/djangoapps/contentstore/rest_api/v1/serializers/group_configurations.py: Add can_manage field
  • cms/djangoapps/contentstore/views/course.py: Add get_course_and_check_view_group_configurations_access, use it for GET in list handler
  • Tests: 3 new tests for staff/editor (can_manage=True) and auditor (can_manage=False)

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_auditor role
  3. GET /api/contentstore/v1/group_configurations/{course_id} → 200 with can_manage: false
  4. Assign course_editor → 200 with can_manage: true
  5. Assign course_staff → 200 with can_manage: true
  6. User with no role → 403
  7. Legacy handler: GET /group_configurations/{course_key} with auditor → should succeed

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

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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
Use COURSES_VIEW_GROUP_CONFIGURATIONS for GET access and
COURSES_MANAGE_GROUP_CONFIGURATIONS 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 group configurations
in read-only mode.

Updates both the REST API v1 view and the legacy view handler.

ENG45-715
@wgu-taylor-payne
wgu-taylor-payne force-pushed the tpayne/view-group-configurations-permission branch from 9f0f375 to 425bfa2 Compare August 21, 2026 20:03
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_group_configurations enforcement in openedx-platform

2 participants