Skip to content

feat: add get_user_role_assignments_per_scope_type api function#339

Merged
mariajgrimaldi merged 2 commits into
openedx:mainfrom
eduNEXT:bav/get-user-role-assignments-per-scope-type
Jun 18, 2026
Merged

feat: add get_user_role_assignments_per_scope_type api function#339
mariajgrimaldi merged 2 commits into
openedx:mainfrom
eduNEXT:bav/get-user-role-assignments-per-scope-type

Conversation

@BryanttV

@BryanttV BryanttV commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Description

Adds get_user_role_assignments_per_scope_type, a user-scoped helper to fetch role assignments filtered by ScopeData subclass. This mirrors the existing get_all_role_assignments_per_scope_type in roles.py, but for a single user.

Usage

from openedx_authz.api.data import CourseOverviewData, OrgCourseOverviewGlobData
from openedx_authz.api.users import get_user_role_assignments_per_scope_type

assignments = get_user_role_assignments_per_scope_type(
    user_external_key=user.username,
    scope_types=(CourseOverviewData, OrgCourseOverviewGlobData),
)

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

openedx-webhooks commented Jun 17, 2026

Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

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.

@BryanttV BryanttV marked this pull request as ready for review June 17, 2026 17:19

@mariajgrimaldi mariajgrimaldi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Thanks a lot!

@mariajgrimaldi mariajgrimaldi merged commit 2b8af69 into openedx:main Jun 18, 2026
8 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Jun 18, 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). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants