Het Mijn Burgerprofiel-menu

Het Mijn Burgerprofiel-menu bestaat uit links op 3 niveaus: primaire, secundaire en applicatieve links.

Primaire links

Dit zijn de links die ook toegankelijk zijn in de startscherm van Mijn Burgerprofiel: Brievenbus, Aanvragen en dossiers, Attesten en vergunningen, COVID-19 en Uw gegevens bij de overheid. Deze links zijn relevant voor de persoon die zich aanmeldt en zijn/haar hoedanigheden  

Secundaire links

Wie is aangemeld als burger ziet Mijn Burgerprofiel als primaire link en bijv. http://e-loketondernemers.be als secundaire link. Wie is aangemeld als ondernemer op e-loketondernemers ziet daar Mijn Burgerprofiel als secundaire link.

Applicatieve links

Dit zijn links die rechtstreeks toegang bieden tot een applicatie van de afnemer en die eigen zijn aan de site waarop de gebruiker is aangemeld, zoals “Mijn Gemeente” of “Mijn VDAB” bijvoorbeeld:

Een eigen menu toevoegen aan het Mijn Burgerprofiel-menu

Om een eigen menu te linken aan het Mijn Burgerprofiel-menu:

vl.widget.client.capture((widget) => {
  // Haal de "Mijn Burgerprofiel"-extensie op om toegang te verkrijgen tot de JS API.
  widget.getExtension('citizen_profile')
    .then((extension) => {
      // Haal de applicatieve menu groep op.
      const menuGroup = extension.getMenu().getGroup('application');
      // Voeg één menu item toe aan deze applicatieve groep.
      menuGroup.add({
        type: 'link',
        label: 'Lorem Ipsum',
        href: 'https://en.lipsum.com',
        target: '_blank',
      });

      // Voeg meerdere menu items toe aan deze applicatieve groep.
      menuGroup.addMultiple([
        {
          type: 'link',
          label: 'Lorem Ipsum',
          href: 'https://en.lipsum.com',
          target: '_blank',
        }
      ]);

      // Verwijder alle menu items uit deze applicatieve groep.
      menuGroup.clear();
  });
});

Wisselen van account

De link Wisselen van account is alleen zichtbaar voor sites waar aanmelden met meerdere hoedanigheden kan. Klikken op de link opent een ACM/IDM-scherm waar de gebruiker kan kiezen met welke hoedanigheid aan te melden. De beschikbare hoedanigheden zijn:

• BUR = Burgers

• EA = Economische actoren (alles wat niet hoort bij OV, LB en GID)

• OV = Onderwijs- en Vormingsinstellingen

• LB = Lokale besturen (dit zijn: gemeente, provincie, autonoom Gemeentebedrijf, autonoom provinciebedrijf, bestuur van de eredienst, brandweerzone, centraal bestuur van de eredienst, hulpverleningszone, intergemeentelijke samenwerking, OCMW, OCMW-vereniging, polder, politiezone, regionaal landschap, stadsdistrict, watering)

• GID = VO GID, alle entiteiten van de Vlaamse overheid

Wisselen van account gebeurt via de hoedanigheidswissel van IDM (doelgroepen). Die hoedanigheidswissel gebeurt altijd in functie van de applicatie/gastwebsite en zorgt voor een rechtstreekse koppeling tussen de persoon die aanmeldt en de header op de gastwebsite. Wisselen van account kan alleen als de gastwebsite gericht aanmelden via ACM/IDM ondersteunt.

In de code betekent dit dat de switchCapacityUrl een pad moet bevatten om die hoedanigheidswissel toe te laten. Dit pad toevoegen kan gebeuren tijdens de integratie van de header.

De session.configure-code kan er als volgt uitzien:

session.configure({
  active: websiteHasAuthenticatedSession,
  endpoints: {
    loginUrl: '/login',
    loginRedirectUrl: '/profile',
    logoutUrl: '/logout',
    // Pad dat de volgende specificatie implementeert:
    // https://authenticatie.vlaanderen.be/docs/beveiligen-van-toepassingen/integratie-methoden/oidc/technische-info/gericht-aanmelden/
    switchCapacityUrl: '/wisselen-van-account'
  },
});

Het endpoint '/wisselen van account' moet door de gastwebsite geïmplementeerd worden. Dat kan op 2 manieren:

• via switch identiteit zoals hier beschreven: https://authenticatie.vlaanderen.be/docs/beveiligen-van-toepassingen/integratie-methoden/oauth/technische-info/switch-identiteit/

• door gericht aan te melden zoals hier beschreven: https://authenticatie.vlaanderen.be/docs/beveiligen-van-toepassingen/integratie-methoden/oauth/technische-info/gericht-aanmelden/

Gericht aanmelden is de aanbevolen methode. Het volstaat dan om als gastwebsite het endpoint te implementeren door een nieuwe aanmeldflow te starten, maar dan met login-hint, bijv.: eyJjYXBfaGludCI6IiJ9 (Base64-representatie van: {"cap_hint":""})

Bijvoorbeeld:

https://authenticatie-ti.vlaanderen.be/op/v1/auth?redirect_uri=... &scope=... &client_id=... &response_type=code&login_hint=eyJjYXBfaGludCI6IiJ9