Feilmeldinger

Når en klient kaller et endepunkt på HelseID-tjeneren, og HelseID ikke godtar kallet, vil det oppstå en feilsituasjon.

Generiske feilmeldinger

De følgende feilmeldingstypene er definert i OAuth 2.0 og OpenID Connect-protokollene. Hver type feilmelding kan være bunnet i flere årsaker. Listen under gir en tolkning av de vanligste feilmeldingene:

Feilmelding Tolkning av feilen
invalid_request Forespørselen til Token-endepunktet ble ikke godtatt. Noen årsaker kan være: En ugyldig HTTP-metode eller innholdstype ble brukt (HelseID vil forvente POST-verbet and "application/x-www-form-urlencoded"), eller en ugyldig autorisasjonskode (Authoriztion Code) ble brukt.
invalid_client Klienten ble ikke autentisert. Denne feilen kan oppstå når private_key_jwt-objektet har blitt signert med en ugyldig nøkkel. Feilen kan også oppstå hvis en ugyldig klient-ID ble brukt i forespørselen.
invalid_grant Denne feilen oppstår gjerne hvis et ugyldig Refresh-token eller autorisasjonskode blir brukt, hvis levetiden på Refresh-tokenet eller autorisasjonskoden har gått ut, eller tilfeller der parametrene i kallet er ugyldige. Når du bruker PKCE, bør du sjekke at mekanismen blir brukt på korrekt vis. Du kan også sjekke at redirekt-URI-en som ble satt i kallet er gyldig for klienten.
unauthorized_client Denne feilen vil ofte indikere at klienten prøver å bruke et type grant som den ikke har anledning til å bruke, eller at en redirigerings-URI er påkrevd.
unsupported_grant_type Denne feiltypen indikerer at grant-typen enten ikke finnes, eller ikke kan brukes for klienten.
unsupported_response_type Denne feilen skal bare oppstå hvis response_type-parameteret ikke finnes i kallet.
invalid_scope Klienten har enten bedt om et scope som den ikke har anledning til å bruke, eller den ber om et identitets-scope ved bruk av maskin-til-maskin (Client Credential)-flyten.
invalid_scope Klienten har enten bedt om et scope som den ikke har anledning til å bruke, eller den ber om et identitets-scope ved bruk av maskin-til-maskin (Client Credential)-flyten.
use_dpop_nonce Klienten har bedt om et DPoP-token, men har ikke brukt en DPoP-nonce i kallet til Token-endepunktet. Dette blir ansett som en feilmelding av HelseID, men fungerer rent teknisk som en mekanisme for å gi ut en DPoP-nonce til klienten.

Feilmeldinger relatert til bruk av JSON-strukturer sendt inn fra klienten

De følgende feilkodene er bare relevante for klienter som sender informasjon til HelseID ved bruk av JSON-strukturer. Eksempler på dette er hovedenhet- og underenhet for enheter nhn:tillitsrammeverk:parameters, eller andre typer «kontekstuelle claim». Feilbeskrivelsen vil i disse tilfellene inneholde et prefiks som beskriver konteksten til feilen, og ekstra tekstinnhold som beskriver hva som gikk feil.

Feilkode Prefiks i beskrivelsen Kommentar
unauthorized_client HID-AUTH: The client is not authorized for the supplied JSON structure. Dette impliserer at klienten ikke har lov til å sende inn den bestemte JSON-typen.
invalid_request HID-JSON: The JSON type could not be parsed. Dette impliserer at klienten ikke har sendt inn et gyldig JSON-dokument.
invalid_grant HID-GRANT: The client is not using the correct grant type. Dette impliserer at klienten har brukt feil grant-type i henhold til JSON-dokumentet som har blitt sendt inn.
invalid_request HID-TYPE: The JSON type could not be validated. Dette impliserer at JSON-typen (altså scopet for JSON-strukturen) ikke ble gjenkjent.
invalid_request HID-STRUCTURE: The JSON structure could not be validated. Dette impliserer at JSON-strukturen fra klienten ikke ble strukturert i henhold til den relevante modellen.
invalid_request HID-CONTENT: The JSON content could not be validated. Dette impliserer at JSON-strukturen fra klienten inneholder ugyldig informasjon.
access_denied HID-DOUBLE-STRUCTURE: The request contained a Tillitsrammeverk structure; however, the structure has already been sent in in another flow. Dette impliserer at klienten har brukt både PAR (eller Authorization)-endepunktet i tillegg til å bruke Token-endepunktet for bruken av nhn:tillitsrammverk:parameters.

Eksempel på en komplett feilbeskrivelse:

HID-CONTENT: The JSON content could not be validated.
At node '$.practitioner_role.organization.identifier.value': No delegation could be found from the organization with org no '100100579' to the supplier, i.e. the provider of the client with client_id = 'ed7c8de2-5ceb-4c02-adb9-3946140eea16'. The client is therefore not allowed to use this organization's number.