AspireForm.Plugin.Auth.ApiKey 0.1.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package AspireForm.Plugin.Auth.ApiKey --version 0.1.0
                    


                    

                
NuGet\Install-Package AspireForm.Plugin.Auth.ApiKey -Version 0.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AspireForm.Plugin.Auth.ApiKey" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="AspireForm.Plugin.Auth.ApiKey" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="AspireForm.Plugin.Auth.ApiKey" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add AspireForm.Plugin.Auth.ApiKey --version 0.1.0
                    


                    

                
#r "nuget: AspireForm.Plugin.Auth.ApiKey, 0.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package AspireForm.Plugin.Auth.ApiKey@0.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=AspireForm.Plugin.Auth.ApiKey&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=AspireForm.Plugin.Auth.ApiKey&version=0.1.0
                    


                            Install as a Cake Tool

AspireForm.Plugin.Auth.ApiKey

API-key authentication Module provider for AspireForm. Scaffolds an ApiKeyAuthSetup.cs helper and a managed AppHost-region comment using shared helpers from AspireForm.Plugin.Auth.Common.

Block type

auth-apikey (Module)

Inputs

Input Type Default Description
headerName string "X-API-Key" The HTTP header name carrying the API key.
keysSource string "config" Source for valid keys: "config" (appsettings) or "db" (database).

File actions

File Ownership Description
<apphost>/ApiKeyAuthSetup.cs Scaffold Starter helper with AddApiKeyAuth extension method. Edit freely — AspireForm will not overwrite it.
<apphost>/AppHost.cs Managed region auth-apikey Registration comment generated by AuthScaffold.RenderRegistrationComment.

Example

modules:
  api-auth:
    type: auth-apikey
    headerName: X-My-Key
    keysSource: db

Dependencies

This plugin depends on AspireForm.Plugin.Auth.Common (shipped as a transitive runtime dependency — no separate install needed).

Product Compatible and additional computed target framework versions.
.NET 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.1.0 90 5/24/2026