Delage.Identity.Client 2.1.1

Introduction

This project aims to enable any project within Delage to seamlessly integrate with our Identity service and provide authentication.

Usage

Authentication

Add to the appSettings.json file:

{
  "Identity": {
    "Authority": "{AUTHORITY_URL}",
    "Audiences": ["audience"],
    "Scopes": ["scope"],
    "EncryptionKey": "ABCDE..."
  }
}

On the ConfigureServices method:

services.AddDelageAuth();

Call UseAuthentication before UseEndpoints in the Configure method:

// omitted

app.UseAuthentication();

// omitted

app.UseEndpoints();

These steps will enable your service to authenticate through Delage's Identity provider.

Configuring Swagger

Call ConfigureDelageAuth in AddSwaggerGen during the ConfigureServices method:

services.AddSwaggerGen(c =>
{
    c.ConfigureDelageAuth(Configuration);
});

Call ConfigureDelageAuth in UseSwaggerUI during the Configure method:

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    // omitted
    c.ConfigureDelageAuth(Configuration);
});

Authorized clients

Authorized clients are a wrapper around the AddHttpClient extension method from IHttpClientFactory. With authorized clients, you can seamlessly authenticate HttpClients that require authentication to access services protected by Delage's Identity provider.

Here is an example of how this can be achieved:

services.AddAuthorizedClient<IOrderService, OrderService>(
    (client, sp) =>
    {
        client.BaseAddress = new Uri("{API_BASE_URL}");
        return new OrderService(client);
    }, 
    options =>
    {
        options.Authority = "{AUTHORITY_URL}";
        options.Scope = "{SCOPE}";
        options.ClientId = "CLIENT_ID";
        options.ClientSecret = "CLIENT_SECRET";
    });

Supported .NET versions

• .NET 6
• .NET 7
• .NET 8

Publishing

Follow SemVer guidelines to increment the version according to the changes made to the project in the Delage.Identity.Client.csproj file.

Once the changes are merged into the develop or master branches, the version will be published to our private NuGet feed located here. A public version will also be published on nuget.org when changes are merged into the master branch.

While in development (on the develop branch) the build number will be automatically appended to the version, e.g., 1.0.0-56.