Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add LmsApiClient.create_enterprise_admin_user() method #637

Merged
merged 1 commit into from
Feb 10, 2025

Conversation

iloveagent57
Copy link
Contributor

Description:
In service of https://2u-internal.atlassian.net/browse/ENT-9970

Merge checklist:

  • ./manage.py makemigrations has been run
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.

Post merge:

  • Ensure that your changes went out to the stage instance
  • Deploy to prod instance

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 10, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @iloveagent57!

This repository is currently maintained by @openedx/2u-enterprise.

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.


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.

@@ -153,6 +154,40 @@ def get_enterprise_admin_users(self, enterprise_customer_uuid):

return results

def create_enterprise_admin_user(self, enterprise_customer_uuid, user_email):
Copy link
Member

Choose a reason for hiding this comment

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

[sanity check / consideration] Will we have a need to create multiple enterprise admin users at once during provisioning? Or will we be able to sufficiently get by with only creating 1 enterprise admin user at a time, as suggested here?

Adding support for the multiple known admin users use case is definitely something that could (and probably should) be deferred, though, with the assumption being additional admins could be added self-serve within the Admin Portal in the future.

Just wanted to verify we're confident we don't need to support the multiple enterprise admin users during provisioning use case to start! :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had the same thought - I think we can assume only one for now, and work out details on supporting multiple later. AFAICT, the enterprise pending admin endpoint doesn't support adding multiple admins in a single request.

Copy link
Member

Choose a reason for hiding this comment

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

AFAICT, the enterprise pending admin endpoint doesn't support adding multiple admins in a single request.

That's my understanding, as well. More reason to deliberately defer on supporting multiple enterprise admins for now.

@iloveagent57 iloveagent57 force-pushed the aed/create-pending-admins branch from 39af41e to 56c7f07 Compare February 10, 2025 20:13
@iloveagent57 iloveagent57 merged commit 8b16678 into main Feb 10, 2025
3 checks passed
@iloveagent57 iloveagent57 deleted the aed/create-pending-admins branch February 10, 2025 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants