Skip to content

feat: add VIEW permission for advanced settings access control#38462

Draft
bra-i-am wants to merge 2 commits intoopenedx:masterfrom
eduNEXT:bc/add-advanced-settings-view-permission
Draft

feat: add VIEW permission for advanced settings access control#38462
bra-i-am wants to merge 2 commits intoopenedx:masterfrom
eduNEXT:bc/add-advanced-settings-view-permission

Conversation

@bra-i-am
Copy link
Copy Markdown

@bra-i-am bra-i-am commented Apr 27, 2026

Description

Modifies check_course_advanced_settings_access in common/djangoapps/student/auth.py to support
read-only access for the course_auditor role by adding a COURSES_VIEW_ADVANCED_SETTINGS permission check.

Changes

  • Added COURSES_VIEW_ADVANCED_SETTINGS to the openedx_authz permission imports
  • Added access_type parameter with three values: read, write, and feature_restricted
  • access_type is validated at the top of the function before any branching
  • When authz is active:
    • MANAGE permission satisfies all three access types
    • VIEW permission satisfies read only (auditor read-only access)
    • When DISABLE_ADVANCED_SETTINGS is enabled, only feature_restricted bypasses authz (staff/superuser only); read and write still go through authz normally
  • Legacy fallback preserved when AUTHZ_COURSE_AUTHORING_FLAG is disabled:
    • readhas_studio_read_access
    • writehas_studio_write_access
    • feature_restrictedhas_studio_advanced_settings_access

Testing instructions

  1. Enable AUTHZ_COURSE_AUTHORING_FLAG
  2. Assign course_auditor role to a user — they should be able to view Advanced Settings in Studio but all fields should be read-only
  3. Assign course_editor or course_staff role — user should have full read + write access
  4. Enable DISABLE_ADVANCED_SETTINGSfeature_restricted should only pass for staff/superuser; read and write should still use authz normally
  5. Disable AUTHZ_COURSE_AUTHORING_FLAG — verify legacy fallback works for all three access types

Supporting information

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

Thanks for the pull request, @bra-i-am!

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.

🔘 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.

@bra-i-am bra-i-am force-pushed the bc/add-advanced-settings-view-permission branch from a42d8e6 to 4115799 Compare April 30, 2026 15:03
@bra-i-am bra-i-am force-pushed the bc/add-advanced-settings-view-permission branch from ca746b2 to 30a662c Compare April 30, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants