17.120. Class AuthenticatorOptions

Namespace: ArmoniK.Core.Common.Auth.Authentication
Assembly: ArmoniK.Core.Common.dll

Options for authentication

[PublicAPI]
public class AuthenticatorOptions : AuthenticationSchemeOptions

17.120.1. Inheritance

objectAuthenticationSchemeOptionsAuthenticatorOptions

17.120.2. 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.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

17.120.3. Fields

17.120.3.1. Default

Default options, will prevent launch as a fail-dead as it requires a proper configuration

public static readonly AuthenticatorOptions Default

17.120.3.1.1. Field Value

AuthenticatorOptions

17.120.3.2. DefaultAuth

Default options used when authentication and authorization are required

public static readonly AuthenticatorOptions DefaultAuth

17.120.3.2.1. Field Value

AuthenticatorOptions

17.120.3.3. DefaultNoAuth

Default options used when no authentication is required

public static readonly AuthenticatorOptions DefaultNoAuth

17.120.3.3.1. Field Value

AuthenticatorOptions

17.120.3.4. SectionName

Section name in the Appsettings file

public const string SectionName = "Authenticator"

17.120.3.4.1. Field Value

string

17.120.4. Properties

17.120.4.1. CNHeader

Header containing the certificate common name

public string CNHeader { get; set; }

17.120.4.1.1. Property Value

string

17.120.4.2. FingerprintHeader

Header containing the certificate fingerprint

public string FingerprintHeader { get; set; }

17.120.4.2.1. Property Value

string

17.120.4.3. ImpersonationIdHeader

Header containing the user id to impersonate

public string ImpersonationIdHeader { get; set; }

17.120.4.3.1. Property Value

string

17.120.4.4. ImpersonationUsernameHeader

Header containing the username to impersonate

public string ImpersonationUsernameHeader { get; set; }

17.120.4.4.1. Property Value

string

17.120.4.5. RequireAuthentication

Flag to activate authentication

public bool RequireAuthentication { get; set; }

17.120.4.5.1. Property Value

bool

17.120.4.6. RequireAuthorization

Flag to activate authorization

public bool RequireAuthorization { get; set; }

17.120.4.6.1. Property Value

bool

17.120.5. Methods

17.120.5.1. CopyFrom(AuthenticatorOptions)

Copies the options of the other object

public void CopyFrom(AuthenticatorOptions other)

17.120.5.1.1. Parameters

other AuthenticatorOptions

Other options to copy from