Altinn.ApiClients.Dialogporten 1.86.4-alpha.1760959560

.NET SDK for Dialogporten ServiceOwner API

Simple overview Refit-based client SDK Based on https://github.com/altinn/altinn-apiclient-maskinporten

The refit-Interface is autogenerated with refitter. It uses OperationId to create method names. Uses refit IApiResponse on returns.

Installation

Install the nuget package through Package Manager Console:

Install-Package Altinn.ApiClients.Dialogporten

Or via .NET Core CLI:

dotnet add package Altinn.ApiClients.Dialogporten

Usage

This package needs some configuration to work. The configuration is done through the DialogportenSettings class. The settings are as follows:

• BaseUri - The base URI of the Dialogporten API.
• ThrowOnPublicKeyFetchInit - If true, the client will throw an exception if the public key fetch fails on startup. Default true.
• Maskinporten - The Maskinporten settings.
  • ClientId - The client ID (secret).
  • EncodedJwk - The encoded JWK (secret).
  • Environment - The environment (test/prod).
  • Scope - Whitespace separated list of scopes to use against Dialogporten.

Registering with IServiceCollection

There are two ways to register

Register through action parameter:

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDialogportenClient(x => 
{
    x.BaseUri = "https://platform.tt02.altinn.no/dialogporten";
    // x.ThrowOnPublicKeyFetchInit = false;
    x.Maskinporten.ClientId = "YOUR_CLIENT_ID";
    x.Maskinporten.EncodedJwk = "YOUR_ENCODED_JWK";
    x.Maskinporten.Environment = "test";
    x.Maskinporten.Scope = "digdir:dialogporten.serviceprovider digdir:dialogporten.serviceprovider.search";
}

Register through options instance parameter:

var builder = WebApplication.CreateBuilder(args);
var dialogportenSettings = builder.Configuration
    .GetSection("DialogportenSettings")
    .Get<DialogportenSettings>()!;
builder.Services.AddDialogportenClient(dialogportenSettings);

In this case, the configuration should look like this:

{
    "DialogportenSettings": {
        "BaseUri": "https://platform.tt02.altinn.no/dialogporten",
        // "ThrowOnPublicKeyFetchInit": false,
        "Maskinporten": {
            "ClientId": "YOUR_CLIENT_ID",
            "EncodedJwk": "YOUR_ENCODED_JWK",
            "Environment": "test",
            "Scope": "digdir:dialogporten.serviceprovider digdir:dialogporten.serviceprovider.search"
        }
    }
}

Available services

The following services are available after registration:

• Altinn.ApiClients.Dialogporten.Features.V1.IServiceownerApi - Used to interact with the Dialogporten ServiceOwner API.
• Altinn.ApiClients.Dialogporten.IDialogTokenValidator - Used to validate Dialogporten tokens.

A background service (IHostedService) is also registered that periodically fetches the public key from the Dialogporten API. This is required to validate dialog token signatures.

See sample project for examples on how to use the services.