OpenIdConnectAuthenticationOptions Class


Configuration options for OpenIdConnectAuthenticationOptions

Namespace:   Microsoft.Owin.Security.OpenIdConnect
Assembly:  Microsoft.Owin.Security.OpenIdConnect (in Microsoft.Owin.Security.OpenIdConnect.dll)

Inheritance Hierarchy



public class OpenIdConnectAuthenticationOptions : AuthenticationOptions
public ref class OpenIdConnectAuthenticationOptions : AuthenticationOptions
type OpenIdConnectAuthenticationOptions = 
        inherit AuthenticationOptions
Public Class OpenIdConnectAuthenticationOptions
    Inherits AuthenticationOptions


Name Description
System_CAPS_pubmethod OpenIdConnectAuthenticationOptions()

Initializes a new OpenIdConnectAuthenticationOptions

System_CAPS_pubmethod OpenIdConnectAuthenticationOptions(String)

Initializes a new OpenIdConnectAuthenticationOptions


Name Description
System_CAPS_pubproperty AuthenticationMode

If Active the authentication middleware alter the request user coming in and alter 401 Unauthorized responses going out. If Passive the authentication middleware will only provide identity and alter responses when explicitly indicated by the AuthenticationType.(Inherited from AuthenticationOptions.)

System_CAPS_pubproperty AuthenticationType

The AuthenticationType in the options corresponds to the IIdentity AuthenticationType property. A different value may be assigned in order to use the same authentication middleware type more than once in a pipeline.(Inherited from AuthenticationOptions.)

System_CAPS_pubproperty Authority

Gets or sets the Authority to use when making OpenIdConnect calls.

System_CAPS_pubproperty BackchannelCertificateValidator

Gets or sets the a pinned certificate validator to use to validate the endpoints used when retrieving metadata.

System_CAPS_pubproperty BackchannelHttpHandler

The HttpMessageHandler used to retrieve metadata. This cannot be set at the same time as BackchannelCertificateValidator unless the value is a WebRequestHandler.

System_CAPS_pubproperty BackchannelTimeout

Gets or sets the timeout when using the backchannel to make an http call.

System_CAPS_pubproperty CallbackPath

An optional constrained path on which to process the authentication callback. If not provided and RedirectUri is available, this value will be generated from RedirectUri.

System_CAPS_pubproperty Caption

Get or sets the text that the user can display on a sign in user interface.

System_CAPS_pubproperty ClientId

Gets or sets the 'client_id'.

System_CAPS_pubproperty ClientSecret

Gets or sets the 'client_secret'.

System_CAPS_pubproperty Configuration

Configuration provided directly by the developer. If provided, then MetadataAddress and the Backchannel properties will not be used. This information should not be updated during request processing.

System_CAPS_pubproperty ConfigurationManager

Responsible for retrieving, caching, and refreshing the configuration from metadata. If not provided, then one will be created using the MetadataAddress and Backchannel properties.

System_CAPS_pubproperty Description

Additional information about the authentication type which is made available to the application.(Inherited from AuthenticationOptions.)

System_CAPS_pubproperty MetadataAddress

Gets or sets the discovery endpoint for obtaining metadata

System_CAPS_pubproperty Notifications

Gets or sets the OpenIdConnectAuthenticationNotifications to notify when processing OpenIdConnect messages.

System_CAPS_pubproperty PostLogoutRedirectUri

Gets or sets the 'post_logout_redirect_uri'

System_CAPS_pubproperty ProtocolValidator

Gets or sets the OpenIdConnectProtocolValidator that is used ensure the 'id_token' received is valid per:

System_CAPS_pubproperty RedirectUri

Gets or sets the 'redirect_uri'.

System_CAPS_pubproperty RefreshOnIssuerKeyNotFound

Gets or sets if a metadata refresh should be attempted after a SecurityTokenSignatureKeyNotFoundException. This allows for automatic recovery in the event of a signature key rollover. This is enabled by default.

System_CAPS_pubproperty Resource

Gets or sets the 'resource'.

System_CAPS_pubproperty ResponseType

Gets or sets the 'response_type'.

System_CAPS_pubproperty Scope

Gets or sets the 'scope'.

System_CAPS_pubproperty SecurityTokenHandlers

Gets or sets the SecurityTokenHandlerCollection of SecurityTokenHandlers used to read and validate SecurityTokens.

System_CAPS_pubproperty SignInAsAuthenticationType

Gets or sets the AuthenticationType used when creating the ClaimsIdentity.

System_CAPS_pubproperty StateDataFormat

Gets or sets the type used to secure data handled by the middleware.

System_CAPS_pubproperty TokenValidationParameters

Gets or sets the TokenValidationParameters

System_CAPS_pubproperty UseTokenLifetime

Indicates that the authentication session lifetime (e.g. cookies) should match that of the authentication token. If the token does not provide lifetime information then normal session lifetimes will be used. This is enabled by default.


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Owin.Security.OpenIdConnect Namespace

Return to top