feat: adding bulk user validation endpoint for admin console#245
feat: adding bulk user validation endpoint for admin console#245jacobo-dominguez-wgu wants to merge 1 commit intoopenedx:mainfrom
Conversation
|
Thanks for the pull request, @jacobo-dominguez-wgu! 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. |
9583a0b to
aa9c08b
Compare
| return True | ||
|
|
||
|
|
||
| class GlobalPermission(MethodPermissionMixin, BasePermission): |
There was a problem hiding this comment.
The functionality of this class looks good, however I'm not convinced on the "Global" name, as we use that term to refer to "*" scopes on other parts of authz.
Perhaps name it like "AnyScopePermission"?
There was a problem hiding this comment.
It make sense, renamed to AnyScopePermission.
aa9c08b to
ba53880
Compare
Description
Implements a new
api/authz/v1/users/validate/endpoint for bulk user validation to support admin console operations during role assignments.Accepts a JSON payload with a users array containing usernames and/or email addresses, validates the list of input data using serializer and checks for required field, proper format, deduplication, and finally processes each identifier individually to check existence.
Required permissions:
manage_library_teamORmanage_course_teamin any scope.Superuser/staff bypass.
It resolves #232
Deadline: Verawood.
Testing instructions
Make sure to have a local tutor dev installation.
Only users with team manage permissions are allowed to use this endpoint.
POST
http://local.openedx.io:8000/api/authz/v1/users/validate/{ "users": [ "user.invalide@example.com", "duplicated_user", "duplicated_user", "any_valid_user" ] }Expected response:
{ "valid_users": [ "any_valid_user", ], "invalid_users": [ "user.invalide@example.com", "duplicated_user", ], "summary": { "total": 3, "valid_count": 1, "invalid_count": 2 } }Merge checklist:
Check off if complete or not applicable: