feat: adding new api endpoint to handle user retirement #1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Since the ecommerce is deprecated and will be maintained in redwood, this PR was directly made to the NAU fork to add an API endpoint to ecommerce that performs user retirement.
For this, the endpoint /api/v2/user/retire. was added, taking advantage of the fact that the function already exists in edx-platform.
As the ecommerce did not store user profile information, this API deletes the social_auth associated with the LMS and modifies both the username and email of the user to comply with the same pattern as in LMS. In this way, the user will be considered retired, and we can compare it with the LMS data if needed to understand how it reached that state.
Regarding validation at the time of authentication, I do not consider it necessary to add a conditional that checks if the user is retired or not, since the ecommerce authentication works via SSO using the LMS and this validation already occurs for retired accounts in the LMS.
If you need to remove or change any user-related data (PII), we can add it to this API to be processed during user retirement process
Testing instructions