docs: Define api contract for User-Grouped role assignments - #437
docs: Define api contract for User-Grouped role assignments#437rodmgwgu wants to merge 2 commits into
Conversation
openedx-webhooks
added
open-source-contribution
|
Thanks for the pull request, @rodmgwgu! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
mphilbrick211
added
the
mao-onboarding
|
|
||
| Query Parameters: | ||
| """"""""""""""""" | ||
|
|
There was a problem hiding this comment.
it is missing the roles filter
| `roles`` (optional): Comma-separated list of roles to filter by (e.g. ``course_auditor,library_admin``). |
There was a problem hiding this comment.
Good catch, I've added it, thanks!
| "is_superadmin": false, | ||
| "role": "library_admin", | ||
| "org": "Org1", | ||
| "scope": "lib:Org1:LIB1", |
There was a problem hiding this comment.
the table shows the name of the scope instead of the id
There was a problem hiding this comment.
Thanks for pointing this out. I added a new "scope_display_name" key and documented edge cases and implementation details.
| - ``scopes`` (optional): Comma-separated list of scopes to filter by (e.g. | ||
| ``lib:Org1:LIB1``). | ||
| - ``orgs`` (optional): Comma-separated list of orgs to filter by (e.g. ``Org1,Org2``). | ||
| - ``search`` (optional): Search term to filter users by username, full name, or email. |
There was a problem hiding this comment.
What is the full name field here? Is this something visible in the UI?
edit: I see it is just the user's full name, wondering if we should allow to search by this given is not visible in the UI, it can return results where the search string isn't visible, I think it might be confusing but maybe no big deal
There was a problem hiding this comment.
It's not being displayed in the design, but in past discussions with Guillermo we decided to include it in the search fields.
5 participants
Closes: #405
The new Team Members tab design for the Admin Console requires fields that are not currently available in the API.
This ADR proposes the contract for updating the existing /api/authz/v1/users/ to support the new Team Members tab use cases.
Merge checklist:
Check off if complete or not applicable:
AI Usage
Kiro was used to refine the prose and clarity of the text, help with rst formatting, as well as to assist on research.
The core ADR contents and direction were drafted by hand.