Skip to content

feat: Implement team members endpoint for admin console#244

Open
rodmgwgu wants to merge 1 commit intoopenedx:mainfrom
WGU-Open-edX:rod/users-endpoint
Open

feat: Implement team members endpoint for admin console#244
rodmgwgu wants to merge 1 commit intoopenedx:mainfrom
WGU-Open-edX:rod/users-endpoint

Conversation

@rodmgwgu
Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu commented Mar 31, 2026

Description

Closes #227

Implemented the /users endpoint to be used in the team members screen on the Admin Console for the AuthZ for Course Authoring project.

Also found and fixed one issue: In the enforcer, the is_admin_or_superuser_check which applies the special case for staff and super user Django users (always are allowed), was not taking into account Org glob scopes.

Deadline: Verawood

How to test

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

http://local.openedx.io:8000/api/authz/v1/users

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": [
        {
            "username": "admin",
            "full_name": "",
            "email": "admin@example.com",
            "assignation_count": 1
        },
        {
            "username": "contributor",
            "full_name": "Juan Contrubuidor",
            "email": "contributor@example.com",
            "assignation_count": 4
        }
    ]
}

You can also test with params, for example:

http://local.openedx.io:8000/api/authz/v1/users?orgs=OpenedX,WGU&scopes=course-v1%3AOpenedX%2BDemoX%2BDemoCourse,lib%3AWGU%3ACSPROB&search=cont&sort_by=email&order=desc

Please note: the scopes should be url-encoded.

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

openedx-webhooks commented Mar 31, 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.

feat: Implement team members endpoint for admin console
@rodmgwgu rodmgwgu force-pushed the rod/users-endpoint branch from 5379ed0 to a710eea Compare April 1, 2026 15:47
@rodmgwgu rodmgwgu marked this pull request as ready for review April 1, 2026 15:53
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Apr 1, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 1, 2026
@mphilbrick211 mphilbrick211 requested a review from a team April 1, 2026 19:20
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: Ready for Review

Development

Successfully merging this pull request may close these issues.

Task - RBAC AuthZ - Implement users endpoint for Admin Console

3 participants