Request for Guidance on Brightspace API Id-Key Authentication Integration
This question is regarding a recent LAM Request case, 02189981
I am currently in the process of integrating Brightspace APIs into my application.At present, I am part of the SSO setup from Carrier with a Learner role, but I require an Integrator role to pull data via the APIs. Matt Walker has advised that assigning both roles to a single individual is not considered a best practice, as it may impact ongoing operational processes.I understand that Brightspace offers an alternative authentication method via Id-Key Authentication. Could you please provide:
- The detailed process for setting up Id-Key Authentication
- A sample authentication and integration flow that enables API access without requiring SSO
- Any best practices for ensuring a seamless integration with our internal application
Your guidance will help us proceed with a secure and efficient integration approach.
Réponses
-
Hi Jason
Thank you for reaching out to us through community!
ID Key Authorization is a proprietary authentication solution that allows developers to write applications that access different services on behalf of a user.
Because ID Key Auth is unique to Brightspace we recommend developers use our standards-based OAuth 2.0 as it is our recommended authentication approach.
Workflow
- Register a new ID Key App using the Brightspace Manage Extensibility tool. Steps can be found here
- Set the new App’s Trusted URL to be that of the API Test Tool
- Request an API Token
- Requesting User is redirected to their Brightspace Login page
- After the user successfully authenticates a User ID Key pair is returned to the Trusted URL (in this case the API Test Tool).
All subsequent Brightspace API calls then must include the App ID and User ID, as well as a computationally generated App Sig and User Sig values. The signature values are typically generated using a Brightspace API SDK.
A very detailed technical ID Key Auth workflow is available here
You can also refer to the below articles for more details
Thanks
Sreelakshmi
- Register a new ID Key App using the Brightspace Manage Extensibility tool. Steps can be found here
