Skip to content

feat: Support filtering by multiple orgs in scopes endpoint#269

Merged
rodmgwgu merged 2 commits intoopenedx:mainfrom
WGU-Open-edX:rod/scopes-orgs-param
Apr 23, 2026
Merged

feat: Support filtering by multiple orgs in scopes endpoint#269
rodmgwgu merged 2 commits intoopenedx:mainfrom
WGU-Open-edX:rod/scopes-orgs-param

Conversation

@rodmgwgu
Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu commented Apr 22, 2026

Adds an optional "orgs" query param to the scopes/ endpoint that accepts a comma-separated list of org names to use for filtering the scopes.

Please note: an "org" query param already existed in that endpoint, but it only supported a single org name per request. We are keeping that optional param for compatibility reasons. If both params are present, both are used for filtering as if the org specified in the "org" query was part of the orgs list on the "orgs" query.

Additional information

Required by: openedx/frontend-app-admin-console#92
Unblocks: openedx/frontend-app-admin-console#111

Testing instructions

Using a local dev tutor installation, call the following endpoint with required credentials:

http://local.openedx.io:8000/api/authz/v1/scopes/?orgs=wgu,OpenedX

The user you use to test this should have permission to at least view one course or library.

You should see a response similar to this:

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "external_key": "course-v1:OpenedX+DemoX+DemoCourse",
            "display_name": "Open edX Demo Course",
            "org": {
                "id": 1,
                "created": "2026-04-02T19:30:36.779095Z",
                "modified": "2026-04-02T19:30:36.779095Z",
                "name": "OpenedX",
                "short_name": "OpenedX",
                "description": "",
                "logo": null,
                "active": true
            }
        },
        {
            "external_key": "lib:WGU:CSPROB",
            "display_name": "Computer Science Problems",
            "org": {
                "id": 2,
                "created": "2026-04-02T19:31:21.196446Z",
                "modified": "2026-04-02T19:31:21.196446Z",
                "name": "WGU",
                "short_name": "WGU",
                "description": "",
                "logo": null,
                "active": true
            }
        }
    ]
}

If you change the orgs query params, for example, removing the "WGU" org name, only the "Open edX Demo Course" will be shown.

Deadline

Verawood

Merge checklist

Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@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 Apr 22, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Apr 22, 2026

Thanks for the pull request, @rodmgwgu!

This repository is currently maintained by @openedx/committers-openedx-authz.

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.

@rodmgwgu rodmgwgu force-pushed the rod/scopes-orgs-param branch from bd13215 to 8a1faa1 Compare April 22, 2026 21:02
@rodmgwgu rodmgwgu marked this pull request as ready for review April 22, 2026 21:12
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Apr 22, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 22, 2026
Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

No notes. LGTM!

Thanks!

Copy link
Copy Markdown
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

Worked for me locally 👍

Copy link
Copy Markdown
Contributor

@BryanttV BryanttV left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Copy Markdown

@bra-i-am bra-i-am left a comment

Choose a reason for hiding this comment

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

@rodmgwgu, thanks a lot for your help with this. It's working as expected!

Screencast.from.23-04-26.08.33.04.webm

@rodmgwgu rodmgwgu merged commit f4962be into openedx:main Apr 23, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Apr 23, 2026
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). 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: Done

Development

Successfully merging this pull request may close these issues.

7 participants