Skip to content

feat: add OAuth 2.0 Client Credentials support for Credly - #3002

Open
luisfelipec95 wants to merge 1 commit into
openedx:masterfrom
Pearson-Advance:lfc/support-oauth-2
Open

feat: add OAuth 2.0 Client Credentials support for Credly#3002
luisfelipec95 wants to merge 1 commit into
openedx:masterfrom
Pearson-Advance:lfc/support-oauth-2

Conversation

@luisfelipec95

Copy link
Copy Markdown
Contributor

Description

This PR adds support for OAuth 2.0 (Client Credentials Grant) authentication for the Credly integration in edx-credentials.

Previously, Credly relied solely on legacy API Keys (Basic Auth). This update enables modern OAuth 2.0 authentication while maintaining full backward compatibility with existing legacy organizations.


Key Changes

1. Database & Models (credentials/apps/badges/models.py)

  • Added oauth_client_id and oauth_client_secret fields to CredlyOrganization.
  • Generated and applied database migrations.

2. API Client (credentials/apps/badges/credly/api_client.py)

  • Added _get_oauth_token() method to handle the OAuth 2.0 token exchange at /oauth/token.
  • Implemented Django cache storage for access tokens to prevent unnecessary HTTP requests during token lifespan.
  • Configured dynamic header resolution in _get_headers(): uses Authorization: Bearer <token> when OAuth credentials are provided, falling back to Authorization: Basic <legacy_key>.
  • Requested badge_templates issued_badges scopes to cover both badge template syncing and badge issuance operations.

3. Django Admin Interface & Forms (admin.py & admin_forms.py)

  • Reorganized CredlyOrganizationAdmin using fieldsets to clearly separate OAuth 2.0 Credentials from Legacy API Key Authentication.
  • Updated CredlyOrganizationAdminForm.clean() and ensure_organization_exists() to validate OAuth credentials via fetch_badge_templates() (since Credly restricts GET /v1/organizations/{id} under Bearer auth).

How to Test

  1. OAuth 2.0 Credentials Flow:

    • Go to Django Admin -> Credly Organizations -> Add Organization.
    • Fill in UUID, Oauth Client ID, and Oauth Client Secret (leave API Key blank).
    • Save the organization. Verify that it validates credentials and saves successfully.
    • Run the action Sync organization badge templates and ensure templates are fetched without error.
  2. Error Handling Check:

    • Enter invalid Client Secret or Client ID.
    • Submit the form. Verify that a clear validation error message appears at the top of the form instead of a 500 error page.
  3. Backward Compatibility Check:

    • Create or edit an organization using only the Legacy API Key.
    • Verify that saving and syncing badge templates still works as expected.
image

@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @luisfelipec95!

This repository is currently maintained by @jajjibhai008.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 14, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 14, 2026
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: No status
Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants