ApiKeySentinelFilter Class

Definition

Namespace

Cuemon.AspNetCore.Mvc.Filters.Headers

Assemblies

Cuemon.AspNetCore.Mvc.dll

Source

src/Cuemon.AspNetCore.Mvc/Filters/Headers/ApiKeySentinelFilter.cs

A filter that confirms request authorization in the form of an API key sentinel.

public class ApiKeySentinelFilter : ConfigurableAsyncAuthorizationFilter<ApiKeySentinelOptions>, IConfigurable<ApiKeySentinelOptions>, IAsyncAuthorizationFilter, IFilterMetadata

Inheritance

object

Configurable<ApiKeySentinelOptions>

ConfigurableAsyncAuthorizationFilter<ApiKeySentinelOptions>

ApiKeySentinelFilter

Implements

IConfigurable<ApiKeySentinelOptions>

IAsyncAuthorizationFilter

IFilterMetadata

Inherited Members

Configurable<ApiKeySentinelOptions>.Options

Examples

The following example creates directly from configured options.

using System;
using System.Net;
using Cuemon.AspNetCore.Http.Headers;
using Cuemon.AspNetCore.Mvc.Filters.Headers;
using Microsoft.Extensions.Options;

namespace MyApp.Examples;

public static class ApiKeySentinelFilterExample
{
    public static void Demonstrate()
    {
        var options = Options.Create(new ApiKeySentinelOptions
        {
            UseGenericResponse = true,
            GenericClientStatusCode = HttpStatusCode.NotFound,
            GenericClientMessage = "Resource not found."
        });
        options.Value.AllowedKeys.Add("Cuemon-Key");

        var filter = new ApiKeySentinelFilter(options);

        Console.WriteLine(filter.Options.HeaderName);
        Console.WriteLine(filter.Options.AllowedKeys.Count);
    }
}

Constructors

Name	Description
ApiKeySentinelFilter(IOptions<ApiKeySentinelOptions>)	Initializes a new instance of the ApiKeySentinelFilter class.

Methods

Name	Description
OnAuthorizationAsync(AuthorizationFilterContext)	Called early in the filter pipeline to confirm request is authorized.

See Also

ApiKeySentinelOptions

ConfigurableAsyncAuthorizationFilter<TOptions>