Getting started

This repository contains two sample implementations for using the Selvbetjening for HelseID API:

1. Create HelseID clients
2. Updating HelseID clients

Full API docs can be found in Selvbetjening for HelseID.

Create HelseID clients

A client template must be created in Selvbetjening for HelseID .

For this sample implementation you need to enable user login and enable support for refresh tokens. The redirect URI should be set to http://localhost:1337/callback when using the default config.

After the client system has been created, navigate to the 'Automation' tab, and generate an API key:

Move into appsettings.json, and paste the API key. This key is used for authenticating against the client drafts endpoint.

{
  ...
  "Selvbetjening": {
    ...
    "ClientDraftApiKeyHeader": "api-key",
    "ClientDraftApiKey": "[PASTE here]"
  }
  ...
}

Creating the client draft

Follow the sample code in ClientRegistrationExample.

1. Create the client draft using the client-drafts endpoint
2. Direct the end user to Selvbetjening for HelseID: /confirm-client/<client_id>, where <client_id> is the ID of the client draft
3. Check the status of the client's access to the specified scopes
4. Authenticate the end user and request access tokens for the specified APIs
5. You're ready to go

Updating HelseID clients

Follow the sample code in ClientUpdateExample.

There are two separate endpoints for updating the client:

1. Updating the client secret
2. Updating the rest of the client configuration

The update operation will affect all properties in the payload as submitted. If a property is set to null in the payload, the property will not be ignored and will be updated in the client configuration.

Example for redirect uris:

If you want to add a redirect uri, you also need to submit the previous redirect uris, along with the rest of the relevant data for the client configuration.
If you want to delete a redirect uri, remove it from the array and call the update endpoint with the rest of the data.
If you set redirect uris to be null, the update will fail if the client system isn't configured to use the same redirect uris for all client configurations.