WsFederationAuthenticationOptions Class

 

Configuration options for WsFederationAuthenticationMiddleware

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

Inheritance Hierarchy

System.Object
  Microsoft.Owin.Security.AuthenticationOptions
    Microsoft.Owin.Security.WsFederation.WsFederationAuthenticationOptions

Syntax

public class WsFederationAuthenticationOptions : AuthenticationOptions

public ref class WsFederationAuthenticationOptions : AuthenticationOptions

type WsFederationAuthenticationOptions = 
    class
        inherit AuthenticationOptions
    end

Public Class WsFederationAuthenticationOptions
    Inherits AuthenticationOptions

Constructors

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

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.)
	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 timeout value in milliseconds for back channel communications.
	CallbackPath	An optional constrained path on which to process the authentication callback. Computed from Wreply if not provided.
	Caption	Get or sets the text that the user can display on a sign in user interface.
	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 address to retrieve the wsFederation metadata
	Notifications	Gets or sets the WsFederationAuthenticationNotifications to call when processing WsFederation messages.
	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.
	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.
	SignOutWreply	Gets or sets the 'wreply' value used during sign-out. If none is specified then the value from the Wreply field is used.
	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.
	Wreply	Gets or sets the 'wreply'.
	Wtrealm	Gets or sets the 'wtrealm'.

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.WsFederation Namespace

Return to top