UserInfo-endepunktet

UserInfo-endepunktet kan brukes for å motta claim om en bruker. Se spesifikasjonen for flere detaljer.

UserInfo-endepunktet er tilgjengelig i HelseID på stien /connect/userinfo, relatert til navnet på tjeneren. For eksempel:

https://helseid-sts.test.nhn.no/connect/userinfo

Endepunktet kan brukes både av en klient og av et API.

⚠️  Bruk av UserInfo-endepunktet

I de fleste tilfellene er ikke bruken av dette endepunktet nødvendig, ettersom den eneste spesifikke informasjonen om brukeren som blir sendt i responsen er detaljer angående brukerens autorisasjon(er) i Helsepersonellregisteret. Hvis programvaren ikke behøver denne informasjonen, vil bruken av Scopes være tilstrekkelig, både for klienter og API-er.

Kall til UserInfo-endepunktet

Programvaren må sende ved et gyldig Access-token i kallet:

GET https://helseid-sts.nhn.no/connect/userinfo
Authorization: Bearer <access_token>

For at programvaren skal få en gyldig respons tilbake, må Access-tokenet inneholde enten helseid://scopes/hpr/hpr_number-scopet eller helseid://claims/hpr/hpr_number-claimet.

Respons fra UserInfo-endepunktet

Responsen er strukturert som et JSON-objekt. Dette objektet vil inneholde claims som beskriver brukeren. Særlig gjelder dette helseid://claims/hpr/hpr_details-claimet, som vil inneholde ekstra detaljer som omhandler brukerens autorisasjon(er) i Helsepersonellregisteret, hvis en slik autorisasjon finnes for brukeren.

Eksempel på en respons:

{
    "helseid://claims/identity/pid": "06828399789",
    "helseid://claims/identity/security_level": "4",
    "helseid://claims/identity/assurance_level": "high",
    "helseid://claims/identity/pid_pseudonym": "PGzVzvP2JvlXV\u002B\u002BOJSJAQG5d99BH8QsikmxpdIAKSZk=",
    "helseid://claims/hpr/hpr_number": "565505933",
    "name": "KVART GREVLING",
    "given_name": "KVART",
    "middle_name": "",
    "family_name": "GREVLING",
    "helseid://claims/identity/network": "internett",
    "userinfo_issued_at": 1714715867,
    "helseid://claims/hpr/hpr_details": {
        "approvals": [
            {
                "profession": "LE",
                "authorization": {
                    "value": "1",
                    "description": "Autorisasjon"
                },
                "requisition_rights": [
                    {
                        "value": "1",
                        "description": "Full rekvisisjonsrett"
                    }
                ],
                "specialities": []
            }
        ],
        "hpr_number": 565505933
    },
    "sub": "PGzVzvP2JvlXV\u002B\u002BOJSJAQG5d99BH8QsikmxpdIAKSZk="
}