Brightspace® ondersteunt server-naar-server API-verificatie met de OAuth 2.0-clienttoegangsverlening die worden toegekend met Clientbevestiging (Private Key JWT). Met dit model kunnen vertrouwde integraties Brightspace® API's aanroepen zonder gebruikersinteractie, terwijl gevoelige LMS-gegevens worden beschermd.
Als u deze functie wilt gebruiken, moet u eerst een speciale servicegebruiker voor de integratie maken en vervolgens een OAuth 2.0-toepassing registreren die deze servicegebruiker gebruikt om toegangstokens te verkrijgen.
|
Belangrijk: Server-naar-server-verificatie is alleen beschikbaar voor OAuth 2.0-toepassingen die zijn gekoppeld aan een servicegebruiker. U moet voor elke integratie een speciale niet-menselijke servicegebruiker met minimale machtigingen gebruiken. Raadpleeg Servicegebruikers beheren voor informatie over het maken van servicegebruikers.
Voor informatie over het instellen van OAuth 2.0-verificatie voor ontwikkelaars raadpleegt u OAuth 2.0-verificatie instellen in de Brightspace®-documentatie voor ontwikkelaars.
|
Vereiste machtigingen
Als u een OAuth 2.0-toepassing wilt registreren voor server-naar-server-verificatie, moet uw rol de volgende machtigingen hebben:
- Servicegebruikers > zie Tool Servicegebruikers
- Uitbreidbaarheid beheren > Kan API-toepassingen beheren
Open de lijst met OAuth 2.0-toepassingen
Beheerders beheren OAuth 2.0-toepassingen vanaf de pagina Uitbreidbaarheid beheren.
De lijst met OAuth 2.0-toepassingen openen:
- Ga naar Beheerprogramma's > Uitbreidbaarheid beheren.
- Klik op het tabblad OAuth 2.0 om de lijst met geregistreerde toepassingen weer te geven.
Op de pagina staan de bestaande OAuth 2.0-toepassingen en hun toekenningsoorten.
Registreer een server-naar-server OAuth 2.0-toepassing
Ga als volgt te werk om een nieuwe OAuth 2.0-toepassing te registreren die gebruikmaakt van de client-referenties die worden toegekend bij clientbevestiging met behulp van een ondertekende JWT:
- Klik op het tabblad OAuth 2.0 op Een app registreren. De pagina Een toepassing registreren wordt geopend.
- Selecteer onder Type toekenning de optie Klantreferenties.
- Voer in Naam toepassing een duidelijke naam in die de integratie identificeert. Bijvoorbeeld Server-to-Server API Client of de naam van de verkoopservice.
- Voer in JWKS URL de HTTPS-URL in die als host fungeert voor de JSON Web Key Set (JWKS) voor uw verificatieserver. Brightspace® gebruikt deze URL om openbare sleutels op te halen voor het verifiëren van ondertekende clientbevestigingen.
- Voer in Bereik het toegestane bereik in voor de aanvragen van de toepassing. Bereik moet de volgende indeling gebruiken
group:resource:permissions. Scheid meerdere bereiken met spaties. Het groepsgedeelte mag geen jokertekenwaarde zijn.
- Voer in Levensduur toegangstoken (seconden) het aantal seconden in dat elk toegangstoken geldig moet blijven. Het minimum is 1800 seconden (30 minuten) en het maximum is 72000 seconden (20 uur).
- Klik onder Servicegebruiker op Servicegebruiker toevoegen en doe het volgende:
- Zoek in het dialoogvenster Servicegebruiker toevoegen naar de servicegebruiker die u eerder voor deze integratie hebt gemaakt.
- Selecteer de Servicegebruiker en klik op Toevoegen
- Bekijk of voer een Beschrijving in waarin het doel van de toepassing en het systeem wordt uitgelegd.
- Selecteer Ik ga akkoord met de API-ontwikkelaarsovereenkomst.
- Klik op Registreren.
De toepassing OAuth 2.0 wordt weergegeven in de lijst met toepassingen met de Type toekenning > Clientreferenties. In deze lijst kunt u bevestigen dat de toepassing is geregistreerd en deze indien nodig later verwijderen.
|
Opmerking: Registratie in Brightspace® maakt alleen de configuratie compleet aan de kant van het platform. Ontwikkelaars moeten ook hun autorisatieserver configureren om ondertekende clientbevestigingen uit te geven die verwijzen naar de geregistreerde toepassing en de JWKS-URL.
|
Volgende stappen voor ontwikkelaars
Nadat de OAuth 2.0-toepassing is geregistreerd, kunnen ontwikkelaars deze gebruiken voor server-naar-server API-verificatie.
- Configureer de externe verificatieserver om een JSON Web Token (JWT) te ondertekenen met de persoonlijke sleutel die overeenkomt met de openbare sleutel in de JWKS-URL.
- Implementeer de OAuth 2.0-clientreferentiestroom met Private Key JWT om de ondertekende JWT uit te wisselen voor een toegangstoken van Brightspace.
- Roep Brightspace® API's aan met behulp van het toegangstoken in de
Authorization: Dragerheader .
|
Belangrijk: De machtigingen die beschikbaar zijn voor API-aanroepen worden bepaald door de rol en machtigingen die zijn toegewezen aan de servicegebruiker die is gekoppeld aan de OAuth 2.0-toepassing. Volg de procedures met de minste bevoegdheden en verleen alleen de machtigingen die vereist zijn om de integratie te laten functioneren.
|