Authlink.Portal.Client.Http 2.13.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.13.0

New Features - Public Client User Management by OAuth2 Client ID:

• AddPublicClientUserAsync - Add a user to a public client using its OAuth2 client ID
• RemovePublicClientUserAsync - Remove a user from a public client using its OAuth2 client ID

This enables consuming applications to manage public client users using the OAuth2 client ID they already know, rather than requiring the internal public client identifier.

Example - Add User to Public Client:

var result = await _client.AddPublicClientUserAsync(new AddPublicClientUserRequest
{
    ClientId = oAuth2ClientId, // The OAuth2 client ID, not the internal public client ID
    UserId = userId
});

if (result.IsError)
{
    // Handle error
    return;
}

var publicClientUserId = result.Value.PublicClientUserId;

Example - Remove User from Public Client:

var result = await _client.RemovePublicClientUserAsync(new RemovePublicClientUserRequest
{
    ClientId = oAuth2ClientId,
    UserId = userId
});

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