Authlink.Portal.Client.Http 2.12.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.11.0

New Features - Registration Link Management:

• GetRegistrationLinksAsync - List registration links with filtering
• GetRegistrationLinkAsync - Get a single registration link by ID
• GetRegistrationLinkBatchAsync - Get batch details including progress
• CreateRegistrationLinkAsync - Create a single registration link
• CreateRegistrationLinkBatchAsync - Create multiple registration links in a batch
• RevokeRegistrationLinkAsync - Revoke a registration link
• ResendRegistrationLinkAsync - Resend a registration link email

Example - Create Single Registration Link:

var result = await _client.CreateRegistrationLinkAsync(new CreateRegistrationLinkRequest
{
    InvitationCodeId = invitationCodeId,
    RecipientEmail = "user@example.com",
    RecipientName = "John Doe",
    ExpiresInDays = 7
});

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

var registrationLinkId = result.Value.RegistrationLinkId;

Example - Create Batch:

var result = await _client.CreateRegistrationLinkBatchAsync(new CreateRegistrationLinkBatchRequest
{
    InvitationCodeId = invitationCodeId,
    Recipients = new List<RecipientInfoDto>
    {
        new() { Email = "user1@example.com", Name = "User One" },
        new() { Email = "user2@example.com", Name = "User Two" }
    },
    ExpiresInDays = 7
});

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