Authlink.Portal.Client.Http 2.19.0

Package Overview

Authlink.Portal.Client.Http provides a ready-to-use, production-grade implementation of the IPortalClient abstraction defined in Authlink.Portal.Client.Core.

Install

dotnet add package Authlink.Portal.Client.Http

Or via Package Manager:

PM> Install-Package Authlink.Portal.Client.Http

What's New in v2.19.0

New Features - Confidential Client Management:

9 new methods for managing OAuth2 confidential clients:

Example - Create a confidential client with a secret:

// Create a confidential client
var createResult = await _client.CreateConfidentialClientAsync(new CreateConfidentialClientRequest
{
    Name = "Agent Service Client",
    Description = "OAuth2 client for agent authentication",
    RequireMtls = false
});

// Add a client secret
var secretResult = await _client.AddConfidentialClientSecretAsync(new AddConfidentialClientSecretRequest
{
    ConfidentialClientId = createResult.Value.ConfidentialClientId,
    NotBefore = DateTime.UtcNow,
    NotAfter = DateTime.UtcNow.AddYears(1)
});

// The secret value is only returned once
var clientSecret = secretResult.Value.ClientSecret;

New Features - Agent Improvements:

Example - Manage User Custom Data:

// Add custom data
await _client.AddUserCustomDataAsync(new AddUserCustomDataRequest
{
    UserId = userId,
    Key = "department",
    Value = "Engineering"
});

// Remove custom data
await _client.RemoveUserCustomDataAsync(new RemoveUserCustomDataRequest
{
    UserId = userId,
    Key = "department"
});

See CHANGELOG.md for full version history.

Usage

Setup

builder.Services.AddPortalHttpClient(options =>
{
    options.BaseUrl = "https://portal.authlink.co.za";
    options.AccessToken = "your-access-token";
});

Basic Usage

public class MyService
{
    private readonly IPortalClient _client;

    public MyService(IPortalClient client)
    {
        _client = client;
    }

    public async Task GetUsersAsync()
    {
        var result = await _client.GetUsersAsync(new GetUsersRequest
        {
            PageNumber = 1,
            PageSize = 10
        });

        if (result.IsError)
        {
            var error = result.FirstError;
            Console.WriteLine($"Error: {error.Code} - {error.Description}");
            return;
        }

        var response = result.Value;
        Console.WriteLine($"Found {response.TotalCount} users");
    }
}

Pattern Matching

var result = await _client.GetUserByIdAsync(new GetUserByIdRequest { UserId = userId });

return result.Match(
    user => Ok(user),
    errors => errors[0].Type switch
    {
        ErrorType.NotFound => NotFound(),
        ErrorType.Unauthorized => Unauthorized(),
        ErrorType.Forbidden => Forbid(),
        _ => Problem(errors[0].Description)
    }
);

Error Types

Authentication Options

Option 1: Static Token (Recommended)

builder.Services.AddPortalHttpClient(options =>
{
    options.BaseUrl = "https://portal.authlink.co.za";
    options.AccessToken = configuration["Authlink:Portal:AccessToken"];
});

Option 2: Custom Token Provider

builder.Services.AddScoped<IAccessTokenProvider, MyTokenProvider>();
builder.Services.AddPortalHttpClient(options =>
{
    options.BaseUrl = "https://portal.authlink.co.za";
});

Runtime Token Updates

if (_tokenProvider is MutableAccessTokenProvider mutableProvider)
{
    mutableProvider.SetAccessToken(newToken);
}

Testing

The package includes comprehensive integration tests. See Integration Tests Documentation.

Documentation

https://docs.authlink.co.za

License

MIT