Class OidcAuthenticationSectionOptions

Namespace

Arc4u.OAuth2.Options

Assembly

Arc4u.OAuth2.AspNetCore.Authentication.dll

The configuration layout of the OpenID Connect authentication. It is bound from the root Authentication section (or the section name given to AddOidcAuthentication). The *Path properties are the paths of the other configuration sections read during registration; each one has a default that can be overridden.

public class OidcAuthenticationSectionOptions

Inheritance

object

OidcAuthenticationSectionOptions

Derived

HybridAuthenticationSectionOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApplicationNameSectionPath

Gets or sets the configuration key whose value is the application name used by data protection. The default is Application.configuration:ApplicationName.

public string ApplicationNameSectionPath { get; set; }

Property Value

string

AuthenticationCacheTicketStorePath

Gets or sets the path of the section holding the CacheTicketStoreOptions of the ticket store. The default is Authentication:AuthenticationCacheTicketStore.

public string AuthenticationCacheTicketStorePath { get; set; }

Property Value

string

AuthenticationMethod

Gets or sets the name of the OpenIdConnectRedirectBehavior used to redirect to the authority: RedirectGet (the default) or FormPost.

public string AuthenticationMethod { get; set; }

Property Value

string

AuthenticationTicketTtl

Gets or sets the time to live of the authentication ticket. The cookie expires after the shorter of this value and RefreshTokenLifetime. The default is 7 days.

public TimeSpan AuthenticationTicketTtl { get; set; }

Property Value

TimeSpan

CallbackPath

Gets or sets the path the identity provider redirects to after the sign-in. The default is /signin-oidc.

public string CallbackPath { get; set; }

Property Value

string

CertSecurityKeyPath

Gets or sets the path of the section describing an optional certificate used as issuer signing key to validate tokens.

public string? CertSecurityKeyPath { get; set; }

Property Value

string

CertificateSectionPath

Gets or sets the path of the section describing the certificate used to protect the data protection keys. The default is Authentication:DataProtection:EncryptionCertificate.

public string CertificateSectionPath { get; set; }

Property Value

string

ClaimsFillerSectionPath

Gets or sets the path of the section holding the ClaimsFillerOptions. The default is Authentication:ClaimsMiddleWare:ClaimsFiller.

public string ClaimsFillerSectionPath { get; set; }

Property Value

string

ClaimsIdentifierSectionPath

Gets or sets the path of the section holding the claim types that identify a user. The default is Authentication:ClaimsIdentifier.

public string ClaimsIdentifierSectionPath { get; set; }

Property Value

string

CookieName

Gets or sets the name of the authentication cookie. Required: use a name specific to the application, for example .MyApp.Cookies.

public string CookieName { get; set; }

Property Value

string

DataProtectionSectionPath

Gets or sets the path of the section holding the CacheStoreOption in which the data protection keys are stored. The default is Authentication:DataProtection:CacheStore.

public string DataProtectionSectionPath { get; set; }

Property Value

string

DefaultAuthority

Gets or sets the default authority (identity provider). Required.

public AuthorityOptions DefaultAuthority { get; set; }

Property Value

AuthorityOptions

DefaultKeyLifetime

Gets or sets the lifetime of the data protection keys. The default is 365 days.

public TimeSpan DefaultKeyLifetime { get; set; }

Property Value

TimeSpan

DomainMappingsSectionPath

Gets or sets the path of the section holding the domain mappings. The default is Authentication:DomainsMapping.

public string DomainMappingsSectionPath { get; set; }

Property Value

string

ForceRefreshTimeoutTimeSpan

Gets or sets the remaining lifetime under which the access token is refreshed. The default is 5 minutes.

public TimeSpan ForceRefreshTimeoutTimeSpan { get; set; }

Property Value

TimeSpan

NameClaimType

Gets or sets the claim type holding the name of the user. The default is name.

public string NameClaimType { get; set; }

Property Value

string

OpenIdSettingsSectionPath

Gets or sets the path of the section holding the OpenIdSettingsOption. The default is Authentication:OpenId.Settings.

public string OpenIdSettingsSectionPath { get; set; }

Property Value

string

RefreshTokenLifetime

Gets or sets the assumed lifetime of a refresh token, which is also the maximum lifetime of the authentication cookie. The default is 90 days.

public TimeSpan RefreshTokenLifetime { get; set; }

Property Value

TimeSpan

ResponseType

Gets or sets the OpenID Connect response type. The default is Code. For AzureAD, AzureB2C and Adfs use Code; for other identity providers CodeIdTokenToken may be needed.

public string ResponseType { get; set; }

Property Value

string

RoleClaimType

Gets or sets the claim type holding the roles of the user. The default is role.

public string RoleClaimType { get; set; }

Property Value

string

TokenCacheSectionPath

Gets or sets the path of the section holding the TokenCacheOptions. The default is Authentication:TokenCache.

public string TokenCacheSectionPath { get; set; }

Property Value

string

ValidateAudience

Gets or sets a value indicating whether the audience of the access token must be validated. The default is true. It is copied to ValidateAudience.

public bool ValidateAudience { get; set; }

Property Value

bool

ValidateAuthority

Gets or sets a value indicating whether the issuer of the access token must be the default authority. The default is true. It is copied to ValidateAuthority.

public bool ValidateAuthority { get; set; }

Property Value

bool