WsFederationAuthenticationOptions Class


Configuration options for WsFederationAuthenticationMiddleware

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

Inheritance Hierarchy



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


Name Description
System_CAPS_pubmethod WsFederationAuthenticationOptions()

Initializes a new WsFederationAuthenticationOptions

System_CAPS_pubmethod WsFederationAuthenticationOptions(String)

Initializes a new WsFederationAuthenticationOptions


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 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 timeout value in milliseconds for back channel communications.

System_CAPS_pubproperty CallbackPath

An optional constrained path on which to process the authentication callback. Computed from Wreply if not provided.

System_CAPS_pubproperty Caption

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

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 address to retrieve the wsFederation metadata

System_CAPS_pubproperty Notifications

Gets or sets the WsFederationAuthenticationNotifications to call when processing WsFederation messages.

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 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 SignOutWreply

Gets or sets the 'wreply' value used during sign-out. If none is specified then the value from the Wreply field is used.

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.

System_CAPS_pubproperty Wreply

Gets or sets the 'wreply'.

System_CAPS_pubproperty Wtrealm

Gets or sets the 'wtrealm'.


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

Return to top