Case studies
Onboarding
We Are Environment
When new cases want to onboard on We Are, the procedure for ethical approval and aligning with Athumi is started via Elfi Goesaert.
Technical requirements
Citizen Authentication
Citizen authentication on the We Are platform is done via ACM: https://www.vlaanderen.be/digitaal-vlaanderen/onze-diensten-en-platformen/veiligheidsbouwstenen-applicatie-en-platformdiensten/acm-idm-standaard-aansluitingsproces
We created a template to request ACM access. It is available below 'ACM-IDM_Onboarding_VITO_WeARe_TEMPLATE.docx'
This document needs to be filled in where marked yellow and send to Frederik Byl , Beau van Gemert , Kristof Dhallé or Mathieu Monsecour, which will review and forward your application. Typical throughput time is about 2 weeks.
Process Authentication
Typical setup of an implementation on the We Are platform consists of a frontend application, communicating with a backend application to interact with the We Are storage. And then a processor or anonimizer process to do extra business logic on the saved data. On the We Are platform, 2 of these components need to be registered in the We Are Identity Provider (We Are IDP).
Currently there doesn't exist a formal process yet to register components. This can be done via email to Frederik Byl , Beau van Gemert , Kristof Dhallé or Mathieu Monsecour. This will result in a registration in the We Are IDP component and the party will be provided webIds, client Ids and client secrets for the components.
Solid document creation
Each component that will be interacting with We Are, needs to be registered in the We Are IDP and therefore own the following Solid documents:
WebId: each agent in We Are will need to be identified by a WebId document. This is a document hosted by We Are and referencing an IDP.
Client Id: the clientId is a unique URL generated by We Are associated with the application.
Client secret: each clientId has a corresponding clientSecret to identify the application towards the We Are IDP
Whitelisting
In order to put an extra layer of security, Athumi manages a system of application whitelisting based on either webId's or clientIds. This whitelisting will be requested by Vito via the following contact persons: Frederik Byl , Beau van Gemert , Kristof Dhallé or Mathieu Monsecour.
Libraries and Demo Code
To implement applications on the We Are platform, we provide Apache 2.0 licensed open source code hosted at https://github.com/orgs/VITObelgium/repositories and libraries deployed on npm: https://www.npmjs.com/.
| We Are Core | Core library to interact with a We Are data store and authenticate via the Solid OIDC flow | https://github.com/VITObelgium/We-Are-Core |
| We Are Expressjs | Middleware library that can be attached to Expressjs applications to take care of these interactions automatically | https://github.com/VITObelgium/We-Are-ExpressJS |
| We Are Demo Frontend | Demo frontend code to interact with an implementation of a backend based on the We Are Core and We Are Expressjs libraries | https://github.com/VITObelgium/We-Are-Demo-Front-End |
| We Are Demo Backend | Demo frontend that contains all necessary logic to interact with We Are data stores | https://github.com/VITObelgium/We-Are-Demo-Back-End |