Mijn OAuth Clients

U klikte in het startscherm onder "Uw Bouwstenen" op "Toegangsbeheer", vervolgens op "API- en Clientbeheer", en tenslotte op "Mijn OAuth Clients". Indien u onthaald wordt op onderstaand scherm, betekent dit dat er momenteel voor uw organisatie geen clients geïntegreerd zijn met het Vlaams Toegangsbeheer (ACM), of dat de clients reeds geclaimd (zie "Permissies wijzigen") werden door andere medewerkers van uw organisatie:

Open

Laat ons er van uit gaan dat er voor uw organisatie wél minstens één client geïntegreerd is met het Vlaams Toegangsbeheer (ACM) en deze client nog niet geclaimd is door andere medewerkers van uw organisatie (zie sectie "Permissies wijzigen"). In onderstaand voorbeeld kan u bijvoorbeeld zien dat er zo, in het tabblad "Voor eigen organisatie", twee clients beschikbaar zijn:

Open

Bij elke client staat aangegeven welke de naam van de client is - hierop kan u doorklikken voor meer detail (zie sectie "Mijn OAuth Client") -  de status van de client, de datum van de laatste update, en een actie-knop "Permissies wijzigen". De functionaliteiten die schuilgaan achter deze actie-knop, worden verderop toegelicht (zie sectie "Permissies wijzigen"). Tenslotte kan u in dit scherm desgewenst ook, door op het vuilnisbak-icoontje te klikken, één van uw clients op eenvoudige wijze verwijderen.

Bij de status van de client wordt, zoals u in bovenstaand voorbeeld kan nagaan, ook aangegeven met hoeveel API's uw client reeds gekoppeld is, alsook voor hoeveel API's u een aanvraag indiende om deze te kunnen bevragen, maar de aanvraag nog op goedkeuring van de API-eigenaar wacht. Zo kan men vaststellen dat "Demo Client A" momenteel al gekoppeld is met één API. "Demo Client B" daarentegen is nog niet gekoppeld met een API, maar er werd wel een aanvraag ingediend om met deze client een bepaalde API te bevragen. De desbetreffende API-eigenaar werd voor een goed begrip vanuit het Beheerportaal via mail verwittigd op het moment dat de aanvraag werd ingediend - maar de aanvraag werd in dit geval dus nog niet goedgekeurd.

Permissies wijzigen

Eigenaars en editeerders aanduiden

Wie komt in aanmerking om als eigenaar of editeerder van een client ingesteld te worden? Dat zijn die medewerkers van uw organisatie die in het Gebruikersbeheer (IDM) geregistreerd zijn als “API-beheerder en Client-beheerder”. Hoe die registratie precies plaatsvindt, kan u op deze pagina terugvinden.

Aan elke client dient exact één eigenaar te worden toegewezen: deze client-eigenaar staat in voor het beheer van de client in kwestie en is het primaire aanspreekpunt van de client. Het aanpassen van de eigenaar van een client heeft vanzelfsprekend ingrijpende gevolgen, dus gelieve steeds voorzichtig om te springen met het aanpassen van eigenaarsrechten. Deze eigenaar dient “API-beheerder en Client-beheerder” te zijn onder dezelfde organisatie waaraan de client hangt.

Aan een client kunnen door de eigenaar ook één of meerdere editeerders toegewezen worden: deze gebruikers kunnen dezelfde operationele beheerstaken voor hun rekening nemen - denk bijvoorbeeld aan het indienen van een aanvraag om een met het Toegangsbeheer (ACM) geïntegreerde API te bevragen - als client-eigenaars, maar zijn geen aanspreekpunt. Editeerders ontvangen derhalve geen updates of bevestigingsmailtjes uit het Beheerportaal; eigenaars wél. De editeerder moet enkel “API-beheerder en Client-beheerder” zijn, hier wordt geen rekening gehouden onder welke organisatie de editeerder dit is.

Als u een nieuwe client aanmaakt voor uw eigen organisatie, dient u meteen mee te geven wie de eigenaar van deze client zal gaan worden: dat kan uzelf zijn, of één van uw collega’s die in het Gebruikersbeheer geregistreerd zijn als “API-beheerder en Client-beheerder”. Meer detail omtrent het aanmaken van een nieuwe client, kan u terugvinden op deze pagina.

U kan ook een nieuwe client aanmaken voor een andere organisatie. Dat is een afspraak die bijvoorbeeld vaak gemaakt wordt tussen lokale besturen en hun dienstenleveranciers: de leverancier wordt belast met het aanmaken van de client, maar de client is wel eigendom van het bestuur; de details van zo’n aanvraag kan u terugvinden op deze pagina. Nu, in zo’n scenario duidt de leverancier het bestuur zélf (bvb. Stad Zottegem) aan als eigenaar van de client. De medewerker van het bestuur die de rechtmatige eigenaar is van de client, zal dan zelf het eigenaarschap moeten claimen in het Beheerportaal. Dat kan als volgt:

• De medewerker van het bestuur die de rechtmatige eigenaar moet worden, wordt in het Gebruikersbeheer geregistreerd als “API-beheerder en Client-beheerder”. Hoe die registratie precies plaatsvindt, kan u op deze pagina terugvinden.

• De medewerker van het bestuur meldt zich aan op het Beheerportaal. Hoe dat kan, wordt beschreven op deze pagina.

• De medewerker navigeert in het Beheerportaal, in “Overzicht Mijn OAuth Clients”, naar het tabje “In afwachting van aanvaarding”. Dat deel van het proces wordt beschreven op deze pagina, en de medewerker claimt de client.

Of dus; het eigenaarschap van de clients van een organisatie kan geclaimd worden door medewerkers van deze organisatie die in het Gebruikersbeheer (IDM) geregistreerd zijn als "API-beheerder en Client-beheerder". Indien uw organisatie in de KBO geregistreerd is, kan ook (één van) de Wettelijke Vertegenwoordiger(s) van uw organisatie het eigenaarschap claimen. Wettelijke Vertegenwoordigers moeten daarvoor in het Gebruikersbeheer geen rechten hebben.

Eigenaars en editeerders aanpassen

Eigenaars van clients kunnen desgewenst editeerders toevoegen of verwijderen, of een nieuwe eigenaar aanduiden in het Beheerportaal. Als de eigenaar bijvoorbeeld op het punt staat om de organisatie te verlaten, is het zonder meer aangewezen dat hij/zij een nieuwe eigenaar aanstelt. Als de eigenaar dat toch vergeten zou zijn, kan één van de medewerkers van de organisatie die in het Gebruikersbeheer (IDM) geregistreerd is als “Lokale Beheerder”, dat ook nog steeds doen.

Voor het toekennen van gebruikersrechten of om te weten wie uw Lokale Beheerder is, kunt u bellen naar het gratis nummer 1700 (Over 1700 ), elke werkdag van 9u tot 19u. Druk keuze 5: andere vragen. Bellen vanuit het buitenland kan ook, maar is niet gratis. Bel daarvoor naar +32 2 553 1700.

Praktijkvoorbeeldje

Veronderstel dat u in het Beheerportaal eigenaar bent van "Demo Client A": u ontvangt alle communicatie omtrent deze client en u neemt het beheer van deze client voor uw rekening. Echter geeft u er de voorkeur aan om dat beheer te delegeren naar één van uw collega’s. U wenst met andere woorden aan deze client een editeerder te koppelen.

Het eerste wat u dient te controleren, is of uw collega in het Gebruikersbeheer (IDM) geregistreerd is als “API-beheerder en Client-beheerder”. Als dat gebeurd is, navigeert u naar het Beheerportaal. Naast de naam van uw client klikt u op de actie-knop "Permissies wijzigen". In het zoekvenster naast "Zoek gebruiker" geeft u vervolgens de coördinaten in van uw collega. U vinkt de checkbox onder "Editeer" aan naast uw collega, en klikt tenslotte op "Wijzigen":

De volgende keer dat uw collega naar het Beheerportaal surft, zal hij/zij uw client nu ook effectief kunnen beheren.

Mijn OAuth Client

U klikte in het scherm "Mijn OAuth Clients" op de naam van één van de clients waarvan u eigenaar dan wel editeerder bent. U belandt op onderstaand scherm:

De veldjes die u hier ziet, komen overeen met de velden die u dient aan te vullen wanneer u een nieuwe client registreert in het Beheerportaal. U kan de inhoud van deze velden wijzigen indien u dat nodig acht. Een gedetailleerde toelichting bij elk van de veldjes kan u desgewenst terugvinden onder “Overzicht specificaties van een nieuwe client”.

Voor een client die reeds geregistreerd is en aan minstens één API gekoppeld is, kan u in dit scherm de details van deze koppeling bekijken: 

Uit bovenstaand voorbeeld mag zo bijvoorbeeld blijken dat "Demo Client A" reeds gekoppeld is aan de API "Voorbeeld API". U kan hier de ClientID van de API raadplegen - in bovenstaand voorbeeld werd deze voor een goed begrip vervangen door "***" - alsook de status, de datum waarop u de koppelingsaanvraag indiende en de datum waarop de aanvraag werd goedgekeurd door de eigenaar van de API. Uiterst rechts kan u in dit scherm desgewenst, door op het vuilnisbak-icoontje te klikken, de koppeling tussen uw client en deze API stopzetten. 

Indien u verder detail wenst te verkrijgen over de koppeling tussen uw client en deze API, kan u doorklikken op de naam van de API - bijvoorbeeld, als men op “Voorbeeld API” zou klikken: 

Hier kan u dus alle details zien van de koppeling van uw client (“Demo Client A”) en een API (“Voorbeeld API”) van agentschap Digitaal Vlaanderen. U kan zo bijvoorbeeld natrekken wie de eigenaar van deze API is - in casu ene “John Doe” - alsook welke scopes uw client mag opvragen bij het aanroepen van deze API.

Hoe interpreteert u bovenstaand voorbeeld? John Doe heeft dus op 12/04/23, omstreeks 18h16, de aanvraag van “Jan Modaal” goedgekeurd: John Doe heeft bevestigd dat Onderneming X gebruik mag maken van de Voorbeeld API. John Doe heeft bovendien aangegeven dat de client van Onderneming X de scopes “voorbeeld_api_read” en “vo_info” mag meesturen bij het bevragen van de API.

Op deze pagina: