Class ApiKeyAuthenticationOptions

Namespace

Stratara.Identity.AspNetCore.Authentication

Assembly

Stratara.Identity.AspNetCore.dll

Options for the Stratara API-key authentication scheme.

public sealed class ApiKeyAuthenticationOptions : AuthenticationSchemeOptions

Inheritance

object

AuthenticationSchemeOptions

ApiKeyAuthenticationOptions

Inherited Members

AuthenticationSchemeOptions.Validate()

AuthenticationSchemeOptions.Validate(string)

AuthenticationSchemeOptions.ClaimsIssuer

AuthenticationSchemeOptions.Events

AuthenticationSchemeOptions.EventsType

AuthenticationSchemeOptions.ForwardDefault

AuthenticationSchemeOptions.ForwardAuthenticate

AuthenticationSchemeOptions.ForwardChallenge

AuthenticationSchemeOptions.ForwardForbid

AuthenticationSchemeOptions.ForwardSignIn

AuthenticationSchemeOptions.ForwardSignOut

AuthenticationSchemeOptions.ForwardDefaultSelector

AuthenticationSchemeOptions.TimeProvider

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

FieldChangedEventExtensions.ApplyPropertyChanged<TAggregate>(TAggregate, FieldChangedEvent<TAggregate>)

EventStream.ApplyEvents(object, IReadOnlyList<IEvent>)

Fields

DefaultHeaderName

The default request header carrying the raw key — X-Api-Key.

public const string DefaultHeaderName = "X-Api-Key"

Field Value

string

QueryParameterName

The query parameter consulted when AllowQueryStringKey is enabled — access_token.

public const string QueryParameterName = "access_token"

Field Value

string

SchemeName

The default scheme name — StrataraApiKey.

public const string SchemeName = "StrataraApiKey"

Field Value

string

Properties

AllowQueryStringKey

Also accept the key via the access_token query parameter. Off by default — query strings leak into logs and referrers; enable only for transports that cannot send custom headers (for example SignalR WebSocket negotiation).

public bool AllowQueryStringKey { get; set; }

Property Value

bool

HeaderName

The request header carrying the raw key. Defaults to DefaultHeaderName.

public string HeaderName { get; set; }

Property Value

string