OpenIdConnectAuthenticationOptions Class

 

Configuration options for OpenIdConnectAuthenticationOptions

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

Inheritance Hierarchy

System.Object
  Microsoft.Owin.Security.AuthenticationOptions
    Microsoft.Owin.Security.OpenIdConnect.OpenIdConnectAuthenticationOptions

Syntax

public class OpenIdConnectAuthenticationOptions : AuthenticationOptions

public ref class OpenIdConnectAuthenticationOptions : AuthenticationOptions

type OpenIdConnectAuthenticationOptions = 
    class
        inherit AuthenticationOptions
    end

Public Class OpenIdConnectAuthenticationOptions
    Inherits AuthenticationOptions

Constructors

	Name	Description
	OpenIdConnectAuthenticationOptions()	Initializes a new OpenIdConnectAuthenticationOptions
	OpenIdConnectAuthenticationOptions(String)	Initializes a new OpenIdConnectAuthenticationOptions

Properties

	Name	Description
	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.)
	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.)
	Authority	Gets or sets the Authority to use when making OpenIdConnect calls.
	BackchannelCertificateValidator	Gets or sets the a pinned certificate validator to use to validate the endpoints used when retrieving metadata.
	BackchannelHttpHandler	The HttpMessageHandler used to retrieve metadata. This cannot be set at the same time as BackchannelCertificateValidator unless the value is a WebRequestHandler.
	BackchannelTimeout	Gets or sets the timeout when using the backchannel to make an http call.
	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.
	Caption	Get or sets the text that the user can display on a sign in user interface.
	ClientId	Gets or sets the 'client_id'.
	ClientSecret	Gets or sets the 'client_secret'.
	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.
	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.
	Description	Additional information about the authentication type which is made available to the application.(Inherited from AuthenticationOptions.)
	MetadataAddress	Gets or sets the discovery endpoint for obtaining metadata
	Notifications	Gets or sets the OpenIdConnectAuthenticationNotifications to notify when processing OpenIdConnect messages.
	PostLogoutRedirectUri	Gets or sets the 'post_logout_redirect_uri'
	ProtocolValidator	Gets or sets the OpenIdConnectProtocolValidator that is used ensure the 'id_token' received is valid per: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
	RedirectUri	Gets or sets the 'redirect_uri'.
	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.
	Resource	Gets or sets the 'resource'.
	ResponseType	Gets or sets the 'response_type'.
	Scope	Gets or sets the 'scope'.
	SecurityTokenHandlers	Gets or sets the SecurityTokenHandlerCollection of SecurityTokenHandlers used to read and validate SecurityTokens.
	SignInAsAuthenticationType	Gets or sets the AuthenticationType used when creating the ClaimsIdentity.
	StateDataFormat	Gets or sets the type used to secure data handled by the middleware.
	TokenValidationParameters	Gets or sets the TokenValidationParameters
	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.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	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