Hieronder staan alle stappen beschreven die nodig zijn om een instelling technisch aan te sluiten op de technische voorzieningen van het Project Studentmobiliteit versie 2. De stappen hoeven niet op volgorde afgehandeld te worden.

Bij het aansluiten van een instelling: Kopieer dit template naar een nieuwe pagina, zodat de status kan worden bijgehouden.


StapOmschrijvingWie?
  • Koppelen SURFeduhub voor onderwijsaanbod

Voor het ophalen van cursus-informatie moet SURFeduhub toegang krijgen tot het OOAPI endpoint (versie 5) van de instelling. Meer informatie over wat het OOAPI endpoint van de instelling moet kunnen is hier te vinden:


https://open-education-api.github.io/specification/#/technical/profiles/eduxchange

https://open-education-api.github.io/specification/#/technical/consumers/eduxchange


Voor het maken van de koppeling dient de volgende informatie aangeleverd te worden aan Herman van Dompseler of Jelmer de Ronde :

  1. URL van het OOAPI endpoint van de instelling.
  2. Of het om een testdata of productiedata gaat.
  3. Eén van de volgende authenticatiegegevens die SURFeduhub nodig heeft om verbinding te mogen maken:
    • Basic authentication = username en password
    • Oauth2 Client Credentials = een token Url, client Id en client Secret
    • Custom API Key Header = bijvoorbeeld een bearer token in de authorization header, zoals: "Authorization: Bearer <myverysecrettoken>"

Na het maken van de koppeling krijgt de instelling voor het testen van de connectie tussen de SURFeduhub en het endpoint toegang tot de gateway met een username en wachtwoord. Deze credentials kunnen ook gebruikt worden om de OOAPI data van het eigen endpoint te valideren via SURFeduhub.

Verantwoordelijke OOAPI endpoint instelling / SIS-leverancier, evt. ook verantwoordelijke ESB instelling


en


Jelmer de Ronde en Herman van Dompseler

  • Koppelen broker courses
Voor het ophalen van cursus-informatie moet de studentenmobiliteit-broker toegang krijgen tot het /courses endpoint van de instelling

Peter Havekes

  • Koppelen eduID ALA
Studenten van de instelling moeten hun eduID kunnen koppelen aan de thuisinstelling. Hiervoor moet de SurfConextVerantwoordelijke een koppeling aanvragen met eduID Account Linking via het SURFconext dashboard.
SurfConextVerantwoordelijke van de Instelling
  • Koppelen oidc intekenontvanger als Relying Party

De intekenontvanger bij de gastinstelling gaat gegevens ophalen bij de thuisinstelling. Hiervoor moet deze worden gekoppeld aan SURFconext

  1. Relying Party Aanmaken
  2. Koppelen aan eduID IdP
  3. Koppelen aan alle Resource Servers uit de Studentenmobiliteit Pilot
  4. ARP instellen op : eduid, epti, givenname
  5. refreshTokenValidity : 31536000
  6. grant : authorisation code, refresh token

Dit kan de instelling of CACI TAB grotendeels zelf uitvoeren via het SP dashboard, het koppelen met de IdP en RS doet SURFconext-Support of Peter Havekes

  1. RP aanmaken: SURF of de instelling via het SPdashboard

Overige stappen SURF (support of Peter Havekes)

  • Koppelen als Resource Server

De instelling gaat persoonsinformatie leveren, en resultaten ontvangen; Hiervoor wordt het OOAPI endpoint aangesloten als Resource Server op De SURFconext API security

  1. Resource Server aanmaken
  2. Scopes aanmaken
  3. Scopes koppelen

De coin:institution_guid van de RP in manage moet gelijk zijn aan de coin:institution_guid van de RS en de IdP van de instelling

  1. RS aanmaken: SURF of de instelling via het SPdashboard

Overige stappen SURF (support of Peter Havekes)

  • Toevoegen informatie aan de serviceregistry van de broker, en de broker opnieuw deployen

In de serviceregistry wordt de volgende informatie per instelling opgenomen, met tussen <> de uitleg en voorbeeldwaarde:


- schacHome: <Primaire domeinnaam voor de instelling, universiteitvanharderwijk.nl>
  name: <Naam van de instelling, Universiteit van Harderwijk >
  abbreviation: <uvh>
  courseEndpoint: <"https://api.uvh.nl/ooapi/v5/offerings">
  courseAuthentication: <BASIC|HEADER|NONE|OAUTH2>
  courseAuthenticationUserName: <In geval van basic authentication de username>
  courseAuthenticationPassword: <In geval van basic authentication het wachtwoord>
  personsEndpoint: "https://rontw-surf.osiris-link.nl/ooapi/persons/me"
  personAuthentication: <HEADER|FORM>
  associationsEndpoint: <"https://api.uvh.nl/ooapi/v5/associations">
  authenticationEndpoint: <"https://intekenontvanger.uvh.nl/inteken-ontvanger-generiek/api/enrollment">
  registrationEndpoint: <"https://intekenontvanger.uvh.nl/inteken-ontvanger-generiek/api/start">
  registrationUser: <"username voor toegang tot de intekenontvanger">
  registrationPassword: <"wachtwoord voor tioegang tot de intekenontvanger">
  logoURI: <"Logo om te tonen bij de instelling, https://universiteitvanharderwijk.nl/images/logo.png">
  scopes: <oidc-scopes voor de instellings-api's, universiteitvanharderwijk.nl/persons universiteitvanharderwijk.nl/results>
  privacyEndpoint: <De locatie van de privacyverklaring van de instelling, https://www.universiteitvanharderwijk.nl/studentmobiliteit>


https://gitlab.surf.nl/student-mobility/inteken-app-ansible/-/tree/master/files

Peter Havekes

  • Toevoegen eppn en eduID aan Osiris student 

Osiris gaat voor bestaande studenten de attributen eppn en eduID inleren. Hiervoor moeten deze attributen worden vrijgegeven aan de Osiris-Student SP van de instelling, als deze via SURFconext is aangesloten kan de SurfConextVerantwoordelijke dit aanvragen vie support@surfconext.nl. Als Osiris-Student rechtstreeks op de IdP van de instelling is aangesloten moet de instelling zelf zorgen voor het vrijgeven van de juiste attributen.

Als Osiris-Student is aangesloten via SURFconext: SurfConextVerantwoordelijke van de Instelling
Anders: IDM-/ADFS-beheerder van de instelling




  • No labels