Teknisk dokumentasjon
I lenkene under finner du dokumenter som inneholder den tekniske dokumentasjonen for HelseID:
- Identitetsleverandører: Styre innlogging i HelseID
- Klientmønstre (single- eller multi-tenant)
- Teknisk referanse:
- Tekniske mekanismer
- Profil for Tillitsrammeverk
Bruksmønstre
Dette scenariet gjelder hvis du bare trenger å logge på en bruker gjennom HelseID og bruke ID-tokenet som kommer i retur for å gjøre autentisering eller autorisasjon.
I dette tilfellet trenger du en pålogget bruker gjennom bruk av OpenID Connect-protokollen, og du må benytte deg av authorization code-flyten mot HelseID. Du finner eksempelkode for dette mønsteret her.
Et spesialtilfelle
Dette scenariet gjelder hvis du skal konsumere ett eller flere REST-API som ikke krever brukerpålogging, og som er sikret med HelseID. Eksempler på dette er
- Persontjenesten
- Helseindikator eller Careplan i Kjernejournal
- Et proprietært REST-API
I dette tilfellet trenger du ikke en pålogget bruker, og kan benytte deg av client-credential-flyten mot HelseID. Du finner eksempelkode for dette mønsteret her.
Spesialtilfeller
- Noen få API i NHN krever organisasjonsnummer med underenhet. Du kan legge til et ekstra claim som inneholder organisasjonsnummeret til en underenhet ved bruk av denne mekanismen.
Dette scenariet gjelder hvis du skal konsumere ett eller flere REST-API som krever brukerpålogging, og som er sikret med HelseID.
I dette tilfellet trenger du en pålogget bruker gjennom bruk av OpenID Connect-protokollen, og du må benytte deg av authorization code-flyten mot HelseID. Du finner eksempelkode for dette mønsteret her.
Bruksmønstre
Spesialtilfeller
- Du kan bruke et smartkort for å logge på en bruker. HelseID støtter bruk av Buypass og Commfides
- Hvis du vil kalle to forskjellige API-er innenfor den samme påloggingssesjonen, kan du bruke denne mekanismen for å skaffe deg et smalt Access-token for hvert API.
- Noen få API i NHN krever organisasjonsnummer med underenhet. Du kan legge til et ekstra claim som inneholder organisasjonsnummeret til en underenhet ved bruk av denne mekanismen.
Dette scenariet gjelder hvis du skal beskytte tilgangen til et (muligens proprietært) REST-API ved hjelp av HelseID. Du kan se et enkelt eksempel på hvordan det gjøres i vår eksempelkode.
Bruk av.DPoP (Demonstrating Proof of Possesion) er obligatorisk for nye API-er som skal bruke HelseID. Les mer om dette i dette dokumentet.
Spesialtilfeller
- Hvis du trenger å kalle et bakenforliggende REST-API, kan du bruke en metode som heter Token Exchange.
- Vi anbefaler at du ikke bruker underenhet fra enhetsregisteret som en mekanisme for tilgangsstyring.