GovUK.Dfe.FlexForms.Api.Client
0.0.48
Prefix Reserved
See the version list below for details.
dotnet add package GovUK.Dfe.FlexForms.Api.Client --version 0.0.48
NuGet\Install-Package GovUK.Dfe.FlexForms.Api.Client -Version 0.0.48
<PackageReference Include="GovUK.Dfe.FlexForms.Api.Client" Version="0.0.48" />
<PackageVersion Include="GovUK.Dfe.FlexForms.Api.Client" Version="0.0.48" />
<PackageReference Include="GovUK.Dfe.FlexForms.Api.Client" />
paket add GovUK.Dfe.FlexForms.Api.Client --version 0.0.48
#r "nuget: GovUK.Dfe.FlexForms.Api.Client, 0.0.48"
#:package GovUK.Dfe.FlexForms.Api.Client@0.0.48
#addin nuget:?package=GovUK.Dfe.FlexForms.Api.Client&version=0.0.48
#tool nuget:?package=GovUK.Dfe.FlexForms.Api.Client&version=0.0.48
FlexForms API Client
The .NET HTTP client used by FlexForms to communicate with the FlexForms API (GovUK.Dfe.FlexForms.Api).
Important: This package is specific to, and dedicated to, the FlexForms service. It is published publicly only so that FlexForms components can consume it. It is not intended for use by any other service, and no support, stability or backwards-compatibility guarantees are offered to consumers outside FlexForms. Breaking changes may be released at any time to suit FlexForms' needs.
Overview
FlexForms is the DfE service for building and running configurable, multi-tenant application forms. This library contains the typed clients, contracts and authentication plumbing that FlexForms front-end hosts (such as FlexForms Web) use to call the FlexForms API on behalf of signed-in users.
The clients and DTOs are generated with NSwag from the FlexForms API's OpenAPI specification, so they always reflect the shape of the API at the version the package was built from.
Key Features
- Typed API clients and contracts - NSwag-generated clients and DTOs for applications, templates, users, roles, tenant administration, files, notifications, reporting and token exchange.
- Token exchange - exchanges a user's DfE Sign-In / Entra identity for a FlexForms API token, with caching and refresh handled by
TokenManagementMiddleware. - Azure bearer tokens - service-to-service authentication against the API using Azure AD tokens.
- Header forwarding - forwards FlexForms context headers (tenant, template and application) from the incoming request to the API.
- User auto-registration - optionally registers users with the API on first sign-in.
- Dependency injection registration - a single
AddExternalApplicationsApiClient<TInterface, TImplementation>()call wires up a client and its HTTP handlers.
Installation
For FlexForms projects only:
dotnet add package GovUK.Dfe.FlexForms.Api.Client
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- GovUK.Dfe.CoreLibs.Contracts (>= 1.0.111)
- GovUK.Dfe.CoreLibs.Http (>= 1.0.12)
- GovUK.Dfe.CoreLibs.Security (>= 1.1.30)
- Microsoft.AspNetCore.Authentication.OpenIdConnect (>= 10.0.3)
- Newtonsoft.Json (>= 13.0.4)
-
net8.0
- GovUK.Dfe.CoreLibs.Contracts (>= 1.0.111)
- GovUK.Dfe.CoreLibs.Http (>= 1.0.12)
- GovUK.Dfe.CoreLibs.Security (>= 1.1.30)
- Microsoft.AspNetCore.Authentication.OpenIdConnect (>= 8.0.14)
- Newtonsoft.Json (>= 13.0.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.0.49 | 34 | 10/16/2026 |
| 0.0.48 | 39 | 10/15/2026 |
| 0.0.47 | 31 | 10/15/2026 |
| 0.0.47-prerelease.2 | 34 | 10/15/2026 |
| 0.0.46 | 71 | 10/13/2026 |
| 0.0.45 | 84 | 10/12/2026 |
| 0.0.44 | 170 | 10/8/2026 |
| 0.0.44-prerelease.39 | 62 | 10/6/2026 |
| 0.0.44-prerelease.21 | 47 | 10/6/2026 |
| 0.0.43 | 135 | 9/25/2026 |
| 0.0.43-prerelease.4 | 67 | 9/25/2026 |
| 0.0.42 | 150 | 9/22/2026 |
| 0.0.42-prerelease.9 | 67 | 9/22/2026 |
| 0.0.42-prerelease.6 | 84 | 9/22/2026 |
| 0.0.41 | 120 | 9/11/2026 |
| 0.0.41-prerelease.75 | 77 | 9/11/2026 |
| 0.0.41-prerelease.60 | 62 | 9/11/2026 |
| 0.0.41-prerelease.46 | 69 | 9/11/2026 |
| 0.0.41-prerelease.33 | 74 | 9/11/2026 |
| 0.0.41-prerelease.21 | 71 | 9/11/2026 |