REST-forespørsler med ID-porten-token

Hvordan bruke Postman til å send REST-forespørsler med ID-porten-token mot Altinns Sluttbruker-API.

Leksjonen er delt opp i følgende steg:

1. Registrere en API-klient i ID-portens Samarbeidsportal.
   • Denne klienten skal bare registreres en gang. Hvis man allerede har en klient (client_id og client_secret) kan man hoppe over dette steget.
2. Sette opp OAuth 2.0 autorisasjon i Authorization panelet i Postman for ID-porten.
   • Dette verktøyet forenkler flyten i OAuth 2.0 autentiseringsprotokollen.
3. Bruke Authorization verktøyet i Postman til å be om et ID-porten token.
   • Dette vil åpne en nettleser hvor man skal autentisere seg med ID-porten som en testbruker.
4. Bruke access_token til å utføre en forespørsel mot https://tt02.altinn.no/api/my/profile.

Registrere en API-klient i Samarbeidsportalen

Logg inn på Samarbeidsportalen - Integrasjoner VER2. Her skal vi opprette en ny integrasjon med følgende oppsett:

• Under Scopes må man spesifisere et eller flere scopes som avgrenser tilgangen til gitte rettighetspakker. For Altinns API er det definert følgende Scopes.
• Redirect URI er et callback-endepunkt som Postman tilbyr. Denne må endres hvis man benytter en annen klient en Postman.
• Levetiden til et Access token blir satt til 1 time som standard, når man setter verdien til 0 i klientregistreringen.

Resultatet av en vellykket registrering vil vise en kvittering:

Ta godt vare på verdien for client_secret! Den og client_id skal vi bruke i neste steg hvor vi setter opp OAuth 2.0 verktøyet i Postman.

Oppsett av OAuth 2.0 autorisasjon i Postman

1. Legg til 3 nye variabler i Postman Environment, som forklart i Collection og Environment-leksjonen. <GUID for …> må erstattes med verdiene man ble tildelt da API-klienten ble opprettet.

   VARIALBLE	TYPE	VALUE-kolonnene
   idporten-client_id	default	<GUID for client_id>
   idporten-client_secret	secret	<GUID for client_secret>

2. Velg Get my/profile forespørselen i Altinn/user/Profile. Naviger til Authorization panelet og velg OAuth 2.0 som type.
3. Sett Add authorization data to til Request Headers. (Dette valget er satt som standard.)
4. Under Configure New Token skal vi sette inn følgende Configuration Options:

   Feltnavn	Verdi
   Token Name	f.eks ID-porten VER2 token
   Grant Type	Authorization Code (With PKCE)
   Callback URL	Authorize using browser
   Auth URL	https://login.test.idporten.no/authorize
   Access Token URL	https://test.idporten.no/token
   Client ID	{{idporten-client_id}}
   Client Secret	{{idporten-client_secret}}
   Code Challenge Method	SHA-256
   Scope	altinn:enduser
   State
   Client Authentication	Send as Basic Auth header

Hente ID-porten token

1. Klikk på Get New Access Token nederst under Configure New Token.
   • Dette vil åpne en nettleser og vise påloggingssiden til ID-porten.
2. Under Velg Elektronisk ID velg Testid.
   • Testid er påloggingsmetoden som er enklest å bruke for alle syntetiske testpersoner som eksisterer i Tenor - Syntetisk Folkeregister.
3. Skriv inn Personidentifikator for en testperson og klikk på Autentiser
   • Hvis det er første gang en testperson blir benyttet blir man spurt om å knytte en epostadresse til brukeren.
4. Velg Godta på dialogen En applikasjon ber om tilgang.
   • Første gang man går igjennom denne dialogen så må man akseptere at Redirect-lenkene åpnes i Postman.
5. Når man blir sendt tilbake til Postman vises Manage Access Tokens-menyen. Klikk på Use Token for å aktivere tokenet som har blitt utstedt.

Nå skal tokenet vises under Current Token.

Bruke ID-porten token i en forespørsel

Når man valgt et token i Authorization panelet så vil det legges til en en ny header på forespørselen: Authorization: Bearer <access_token>. Denne headeren vises ikke som standard, men hvis man klikker på Show auto-generated headers så vises den øverst slik det vises på bildet under.

1. Før man kan sende denne forespørselen må man sørge for at {{ApiKey}} environment variabelen inneholder en API-nøkkel som gir tilgang til Organization.read.
   • Se Nødvendig forarbeid.
2. Klikk Send
   • Nå skal man få tilbake et svar med status 200 OK som inneholder profilen til testbrukeren.

Dette tokenet kan gjenbrukes på andre forespørseler så lenge man ikke overskrider levetiden til tokenet. Dette gjøres enkelt ved å velge et annet endepunkt og gå til Authorization panelet og velge OAuth 2.0. Da skal både det aktive tokenet og oppsettet for å spørre om et nytt token være satt. Vær obs på at vi begrenset Scopes til altinn:enduser, så alle endepunkt på tjenesteeier API er ikke inkludert.

Se også

• Hvordan importere Altinn API collection og environment
• Hvordan legge til et virksomhetssertifikat i Postman
• Nødvendig forarbeid - Postman introduksjon
• REST forespørsler mot åpne API-endepunkter
• REST-forespørsler med Altinn-exchange-token