Autentisering
Hvordan autentisere mot Dialogporten
Introduksjon
Dialogporten API-et er delt inn i et tjenesteeier-API og et sluttbruker-API.
API | Støttede autentiseringsmetoder |
---|---|
Sluttbruker | ID-porten, Maskinporten 1 |
Tjenesteeier | Maskinporten 2 |
I tillegg støttes token utstedt av Altinn Token Exchange, ved bruk av enten ID-porten eller Maskinporten som input.
Bruk for sluttbrukersystemer
Sluttbrukersystemer kan enten bruke et ID-porten-token, som identifiserer en person, eller et Maskinporten-token som identifiserer en systembruker.
ID-porten-autentisering
ID-porten-autentisering bør brukes av sluttbrukersystemer som ønsker å få tilgang til Dialogporten og relaterte tjenester ved hjelp av identiteten til en enkelt person, og bruke deres autorisasjon for å få tilgang til dialoger som er tilgjengelige på tvers av partene som den autentiserte brukeren har tilgang til. Dette er API-et som brukes av det vanlige GUI-grensesnittet (“arbeidsflate”) som er tilgjengelig etter innlogging på altinn.no.
Følgende generelle trinn må utføres for å få tilgang til sluttbruker-API-et som en person:
- Opprett en ID-porten-integrasjon (OAuth2-klient)
- Provisiones scope
digdir:dialogporten
på klienten, samt eventuelle tilleggs scope som kreves for tilgang til innholdsdata (dvs.altinn:correspondence.read
) - Omdiriger brukeren til autorisasjonsendepunktet i ID-porten, hvor de autentiserer seg og samtykker til at integrasjonen din får tilgang til å kalle Dialogporten på dine vegne
- På omdirigeringsendepunktet ditt bruker du autorisasjonskoden som er gitt mot ID-porten token-endepunktet for å få et tilgangstoken
- Utfør forespørsler til sluttbruker-API ved hjelp av tilgangstokenet i en
Authorization: Bearer <token>
header.
ID-porten implementerer en standard OAuth2-protokoll, og utsteder refresh tokens som kan lagres og gjenbrukes for å få nye tilgangstokens på et senere tidspunkt. Autoriseringer (OAuth “samtykker”) til digdir:dialogporten
scope er gyldige i opptil 90 dager.
For detaljerte trinn om hvordan du oppretter en ID-porten-integrasjon og bruker OAuth2-protokollen, se ID-porten-dokumentasjonen som er lenket nedenfor.
Les mer
Maskinporten-autentisering med systembrukere
Systembrukere er den nye og foretrukne autentiseringsmetoden der en organisasjon kan opprette en “virtuell bruker”, delegere tjenesterettigheter til den og knytte den til et system - enten selveid eller levert av en tredjepart. Dette er etterfølgeren til “virksomhetsbruker” i Altinn 2, og gir en sikrere og mer brukervennlig onboarding-prosess for kunder og sluttbrukere.
Følgende generelle trinn må utføres for å få tilgang til sluttbruker-API-et som systembruker:
- Logg inn i Altinn, og velg å representere organisasjonen du ønsker å opprette systembrukeren i.
- Naviger til profilinnstillinger, og seksjonen “Systembrukere”
- Opprett en ny systembruker, og knytt den enten til et leverandørlevert system, eller velg å opprette din egen Maskinporten-integrasjon
- Gi tjenesterettigheter til systembrukeren
- Opprett en JWT grant som identifiserer systembrukeren og
digdir:dialogporten
scope, samt eventuelle tilleggs scope som kreves for tilgang til innholdsdata (dvs.altinn:correspondence.read
), signer den og send den til Maskinporten token-endepunktet for å få et tilgangstoken. - Utfør forespørsler til sluttbruker-API ved hjelp av tilgangstokenet i en
Authorization: Bearer <token>
header.
For detaljerte trinn om hvordan du oppretter og bruker en systembruker, se lenken nedenfor.
Les mer
Bruk for tjenesteeiersystemer
Tjenesteeiersystemer må bruke Maskinporten-utstedte tokens, eventuelt utvekslet i Altinn Token Exchange.
Det finnes flere scopes som definerer tilgang til forskjellige deler av tjenesteeier-APIet:
Scope | Gir tilgang til |
---|---|
digdir:dialogporten.serviceprovider | Alle tjenesteeier-APIer, unntatt søke/liste-API-et |
digdir:dialogporten.serviceprovider.search | Alle tjenesteeier-APIer, inkludert søke/liste-API-et |
digdir:dialogporten.serviceprovider.correspondence | Opprett og oppdater dialoger som refererer en tjenesteressurs av typen CorrespondenceService i Altinn Resource Registry (kun intern bruk) |
Bruk av disse scope krever at organisasjonen i consumer
claim er registrert som en tjenesteeier (“org”) i Altinn. Hvis ikke vil alle forespørsler mislykkes.
Følgende generelle trinn må utføres for å få tilgang til Dialogporten tjenesteeier-API:
- Opprett en Maskinporten-integrasjon (OAuth2-klient)
- Provisiones scope
digdir:dialogporten.serviceprovider
på klienten - Generer en JWT grant som refererer til klient-ID-en din og scope, signer den og send den til Maskinporten token-endepunktet
- På omdirigeringsendepunktet ditt bruker du autorisasjonskoden som er gitt mot Maskinporten endepunktet for å få et tilgangstoken.
- Utfør forespørsler til tjenesteeier API ved hjelp av tilgangstokenet i en
Authorization: Bearer <token>
header.
For detaljerte trinn om hvordan du bruker Maskinporten, se lenken nedenfor.
Les mer
Gi tilgang til leverandører
Tjenesteleverandør-scope er delegerbare via Altinn API-delegering. Tjenesteeierorganisasjoner kan bruke leverandører til å bruke Dialogporten tjenesteeier-APIer på sine vegne, ved hjelp av API-delegering i Altinn. API-et heter “Dialogporten Serviceowner API”. Følg lenkene nedenfor for en veiledning om hvordan du gjør dette:
Les mer