De Brightspace API biedt ontwikkelaars twee verificatiemethoden: OAuth 2.0 en onze eigen gepatenteerde Id Key Auth. Deze verificatiegids richt zich op OAuth 2.0. Houd er rekening mee dat we u aanmoedigen om de OAuth 2.0-standaard te gebruiken, omdat we daar bij D2L in investeren.
Ongeacht de verificatiebenadering zijn de best practices voor beveiliging die hier worden beschreven, van toepassing.
App-beveiliging
API-apps bieden een zeer krachtige manier om toegang te krijgen tot Brightspace. De combinatie van de informatie van een API-app plus een Brightspace-gebruikersaccount geeft toegang tot de Brightspace API. Het is daarom belangrijk om API App informatie beschikbaar te houden voor een minimaal aantal mensen. Het belangrijkste is dat u deze stukjes informatie veilig houdt:
- OAuth 2.0 - Geheim van de cliënt
- ID-sleutel Auth - App-sleutel
Context voor Brightspace-gebruikers
Elke Brightspace-gebruiker is ingeschreven in Brightspace-organisatie-eenheden met een specifieke rol. De rechten van die rol bepalen wat de gebruiker wel en niet kan doen binnen de gebruikersinterface van Brightspace en met de Brightspace API.
OAuth 2.0-bereiken
OAuth 2.0 biedt een extra niveau van controle over de toegang tot Brightspace via onze API. Bij OAuth 2.0 zijn de Brightspace-rechten van de gebruiker nog steeds van toepassing, maar moet de OAuth 2.0-app die wordt gebruikt ook beschikken over voldoende scopes om API-aanroepen uit te voeren. Een een lijst met beschikbare OAuth 2.0-scopes is beschikbaar in onze Brightspace API-documentatie.
kern:*:*
Niet alle API-routes hebben een gedefinieerd OAuth 2.0-bereik. Deze routes maken gebruik van een speciaal bereik met de naam "core:*:*". We zijn van plan om in de loop van de tijd meer specifieke OAuth 2.0-bereiken toe te voegen. Terwijl we dit doen, zullen we het bereik "kern:*:*" voor die routes blijven ondersteunen. Het wordt echter ten zeerste aanbevolen dat apps hun bereikdefinitie bijwerken om af te stemmen op de meest specifieke bereikwaarden die beschikbaar zijn.
Weg
Documentatie
Brightspace API en gebruikerscontext
Tabel OAuth 2.0-scopes
Aan de slag met OAuth 2.0 Scopes - Veelgestelde vragen
Gemeenschap
ID-sleutelverificatie - Veelgestelde vragen en best practices voor gebruikersverificatie