feat: add OAuth 2.0 Client Credentials support for Credly - #3002
feat: add OAuth 2.0 Client Credentials support for Credly#3002luisfelipec95 wants to merge 1 commit into
Conversation
|
Thanks for the pull request, @luisfelipec95! 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. |
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)oauth_client_idandoauth_client_secretfields toCredlyOrganization.2. API Client (
credentials/apps/badges/credly/api_client.py)_get_oauth_token()method to handle the OAuth 2.0 token exchange at/oauth/token._get_headers(): usesAuthorization: Bearer <token>when OAuth credentials are provided, falling back toAuthorization: Basic <legacy_key>.badge_templates issued_badgesscopes to cover both badge template syncing and badge issuance operations.3. Django Admin Interface & Forms (
admin.py&admin_forms.py)CredlyOrganizationAdminusingfieldsetsto clearly separate OAuth 2.0 Credentials from Legacy API Key Authentication.CredlyOrganizationAdminForm.clean()andensure_organization_exists()to validate OAuth credentials viafetch_badge_templates()(since Credly restrictsGET /v1/organizations/{id}under Bearer auth).How to Test
OAuth 2.0 Credentials Flow:
UUID,Oauth Client ID, andOauth Client Secret(leaveAPI Keyblank).Error Handling Check:
Client SecretorClient ID.Backward Compatibility Check: