feat: add certificate management v2 API endpoints by wgu-jesse-stewart · Pull Request #38404 · openedx/openedx-platform

wgu-jesse-stewart · 2026-04-21T21:25:21Z

Add ToggleCertificateGenerationView endpoint to enable/disable certificate generation
Add CertificateExceptionsView endpoint to grant and remove certificate exceptions (allowlist)
Add CertificateInvalidationsView endpoint to invalidate and re-validate certificates
Update certificate status labels to be more user-friendly (e.g., "Received" instead of "already received")
Update certificate generation history labels (e.g., "All Learners" instead of "All learners")
Add invalidation notes to IssuedCertificateSerializer
Add certificates_enabled flag to CourseInformationSerializerV2

Description

This PR adds comprehensive v2 API endpoints for certificate management in the instructor dashboard, supporting the new React-based instructor dashboard UI.

Changes include:

New API Endpoints:
- POST /api/instructor/v2/courses/{course_id}/certificates/toggle_generation - Enable/disable certificate generation for a course
- POST /api/instructor/v2/courses/{course_id}/certificates/exceptions - Grant certificate exceptions (allowlist) to learners
- DELETE /api/instructor/v2/courses/{course_id}/certificates/exceptions - Remove certificate exceptions
- POST /api/instructor/v2/courses/{course_id}/certificates/invalidations - Invalidate certificates for learners
- DELETE /api/instructor/v2/courses/{course_id}/certificates/invalidations - Re-validate (remove invalidation) certificates
Data Model Updates:
- Updated certificate status labels to be more user-friendly:
  - "downloadable" → "Received"
  - "notpassing" → "Not Received"
  - "unavailable" → "Invalidated"
  - "error" → "Error State"
  - "audit_passing" → "Audit - Passing"
  - "audit_notpassing" → "Audit - Not Passing"
- Updated certificate generation history labels:
  - "All learners" → "All Learners"
  - "For exceptions" → "Granted Exceptions"
Serializer Enhancements:
- Added invalidation_note field to IssuedCertificateSerializer to include notes about certificate invalidations
- Added certificates_enabled flag to CourseInformationSerializerV2 to indicate if certificate management is available

Key Features:

Bulk operations support with detailed error handling - returns separate success and error lists
Validation checks to prevent invalid operations (e.g., granting exceptions to non-enrolled users, invalidating already-invalidated certificates)
Proper permission checks using existing instructor permissions

User Roles Impacted:

Instructors/Course Staff - Can manage certificate exceptions and invalidations through the new instructor dashboard UI

Supporting information

Related to the instructor dashboard v2 modernization effort.

Testing instructions

Toggle Certificate Generation:

curl -X POST /api/instructor/v2/courses/{course_id}/certificates/toggle_generation \
  -H "Authorization: Bearer {token}" \
  -d '{"enabled": false}'

Expected: Returns {"enabled": false}

Grant Certificate Exceptions (bulk):

curl -X POST /api/instructor/v2/courses/{course_id}/certificates/exceptions \
  -H "Authorization: Bearer {token}" \
  -d '{"learners": ["user1", "user2@example.com"], "notes": "Test exception"}'

Expected: Returns success/error lists for each learner

Remove Certificate Exception:

curl -X DELETE /api/instructor/v2/courses/{course_id}/certificates/exceptions \
  -H "Authorization: Bearer {token}" \
  -d '{"username": "user1"}'

Expected: Returns success message

Invalidate Certificates (bulk):

curl -X POST /api/instructor/v2/courses/{course_id}/certificates/invalidations \
  -H "Authorization: Bearer {token}" \
  -d '{"learners": ["user1", "user2@example.com"], "notes": "Reason for invalidation"}'

Expected: Returns success/error lists for each learner

Remove Certificate Invalidation:

curl -X DELETE /api/instructor/v2/courses/{course_id}/certificates/invalidations \
  -H "Authorization: Bearer {token}" \
  -d '{"username": "user1"}'

Expected: Returns success message

Deadline

None

Other information

These endpoints follow the same patterns as other v2 instructor API endpoints
No database migrations required - uses existing models
Backwards compatible - does not modify existing v1 endpoints
Frontend PR: [link to frontend-app-instruct PR when created]

- Add ToggleCertificateGenerationView endpoint to enable/disable certificate generation - Add CertificateExceptionsView endpoint to grant and remove certificate exceptions (allowlist) - Add CertificateInvalidationsView endpoint to invalidate and re-validate certificates - Update certificate status labels to be more user-friendly (e.g., "Received" instead of "already received") - Update certificate generation history labels (e.g., "All Learners" instead of "All learners") - Add invalidation notes to IssuedCertificateSerializer - Add certificatesEnabled flag to CourseInformationSerializerV2

openedx-webhooks · 2026-04-21T21:25:26Z

Thanks for the pull request, @wgu-jesse-stewart!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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.

Copilot

Pull request overview

Adds new Instructor Dashboard v2 endpoints to manage course certificate generation, exceptions (allowlist), and invalidations, plus updates to certificate-related labels/serialization to support the React-based instructor dashboard UI.

Changes:

Introduces v2 API endpoints to toggle certificate generation, manage certificate exceptions, and manage certificate invalidations.
Extends v2 serializers to expose certificate-management availability and invalidation notes.
Updates certificate status/history “human-readable” labels and adjusts related tests.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 16 comments.

Show a summary per file

File	Description
lms/djangoapps/instructor/views/serializers_v2.py	Adds `certificates_enabled` and `invalidation_note` to v2 serializers.
lms/djangoapps/instructor/views/api_v2.py	Adds new v2 certificate management APIViews and extends issued-certs context with invalidation notes.
lms/djangoapps/instructor/views/api_urls.py	Wires new v2 certificate management routes.
lms/djangoapps/instructor/tests/test_api_v2.py	Updates expected certificate generation history label casing.
lms/djangoapps/certificates/tests/test_models.py	Updates expected label strings for generation history candidate rendering.
lms/djangoapps/certificates/models.py	Updates generation history candidate strings (“All Learners”, “Granted Exceptions”).
lms/djangoapps/certificates/data.py	Updates human-readable certificate status labels and adds mapping for `unavailable`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dwong2708

Thanks for all the effort. I’ve left my first round of reviews.

…tificates_v2

dwong2708

These should be the latest suggestions. Thanks!

dwong2708 · 2026-04-24T02:44:48Z

+                    user.id, course_key
+                )
+                try:
+                    task_api.generate_certificates_for_students(


According to the docstring, this raises an AlreadyRunningError if certificates are currently being generated. It should be handled here and communicated to the user.

dwong2708 · 2026-04-24T02:51:20Z

+    """
+    Serializer for granting certificate exceptions (bulk).
+    """
+    learners = serializers.ListField(


I think we should add max_length= to prevent a large number of learners.

dwong2708 · 2026-04-24T02:52:07Z

+    """
+    Serializer for invalidating certificates (bulk).
+    """
+    learners = serializers.ListField(


I think we should add max_length= to prevent a large number of learners.

dwong2708 · 2026-04-24T02:54:22Z

+        for learner, user in exceptions_to_create:
+            try:
+                certs_api.create_or_update_certificate_allowlist_entry(user, course_key, notes)
+                results['success'].append(learner)


Should we audit (Logging) which learners were affected?

dwong2708 · 2026-04-24T02:55:35Z

+                    )
+                    # Invalidate the certificate with explicit source for auditability
+                    certificate.invalidate(source='instructor_api_v2')
+                    results['success'].append(learner)


Should we audit (Logging) which learners were affected?

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 Apr 21, 2026

openedx-webhooks added this to Contributions Apr 21, 2026

github-project-automation Bot moved this to Needs Triage in Contributions Apr 21, 2026

wgu-jesse-stewart added 4 commits April 21, 2026 17:37

fix: linting

d2de81c

fix: linting

4a355f5

fix: linting

ea687fe

fix: linting

5f7d3df

dwong2708 requested a review from Copilot April 21, 2026 23:49

Copilot started reviewing on behalf of dwong2708 April 21, 2026 23:50 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

wgu-jesse-stewart added 6 commits April 22, 2026 11:06

feat: PR feedback

5d08560

fix: Removed the unused invalidated_user_ids

a394008

feat: update tests

0d8809e

feat: update tests

33364c0

feat: update tests

2d2c62a

feat: update tests

6b9a2e9

dwong2708 suggested changes Apr 22, 2026

View reviewed changes

Comment thread lms/djangoapps/instructor/views/api_v2.py Outdated

feat: PR feedback

66e1243

mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Apr 22, 2026

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Apr 22, 2026

fix: tests

1b43fc5

wgu-jesse-stewart marked this pull request as ready for review April 22, 2026 23:36

wgu-jesse-stewart requested a review from a team as a code owner April 22, 2026 23:36

wgu-jesse-stewart requested a review from dwong2708 April 23, 2026 14:07

dwong2708 suggested changes Apr 23, 2026

View reviewed changes

Comment thread lms/djangoapps/instructor/views/api_v2.py Outdated

Comment thread lms/djangoapps/instructor/views/api_v2.py Outdated

wgu-jesse-stewart added 3 commits April 23, 2026 14:53

feat: PR feedback

d8ff883

fix: build

684a245

fix: tests

2902be9

wgu-jesse-stewart requested a review from dwong2708 April 23, 2026 21:54

dwong2708 suggested changes Apr 23, 2026

View reviewed changes

Comment thread lms/djangoapps/instructor/views/api_v2.py Outdated

wgu-jesse-stewart added 2 commits April 23, 2026 19:20

feat: wrap create_certificate_invalidation_entry in atomic

daf8ce0

Merge branch 'master' into wgu-jesse-stewart/instructor_dashboard_cer…

397b8f8

…tificates_v2

wgu-jesse-stewart requested a review from dwong2708 April 23, 2026 23:21

dwong2708 suggested changes Apr 24, 2026

View reviewed changes

Conversation

wgu-jesse-stewart commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other information

Uh oh!

openedx-webhooks commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dwong2708 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dwong2708 left a comment

Choose a reason for hiding this comment

Uh oh!

dwong2708 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

dwong2708 Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

wgu-jesse-stewart commented Apr 21, 2026 •

edited

Loading

openedx-webhooks commented Apr 21, 2026 •

edited

Loading