OpenIdConnectAuthenticationOptions Class

 

Configuration options for OpenIdConnectAuthenticationOptions

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

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

public ref class OpenIdConnectAuthenticationOptions : AuthenticationOptions

NameDescription
System_CAPS_pubmethodOpenIdConnectAuthenticationOptions()

Initializes a new OpenIdConnectAuthenticationOptions

System_CAPS_pubmethodOpenIdConnectAuthenticationOptions(String^)

Initializes a new OpenIdConnectAuthenticationOptions

NameDescription
System_CAPS_pubpropertyAuthenticationMode

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_pubpropertyAuthenticationType

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_pubpropertyAuthority

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

System_CAPS_pubpropertyBackchannelCertificateValidator

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

System_CAPS_pubpropertyBackchannelHttpHandler

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

System_CAPS_pubpropertyBackchannelTimeout

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

System_CAPS_pubpropertyCallbackPath

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_pubpropertyCaption

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

System_CAPS_pubpropertyClientId

Gets or sets the 'client_id'.

System_CAPS_pubpropertyClientSecret

Gets or sets the 'client_secret'.

System_CAPS_pubpropertyConfiguration

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_pubpropertyConfigurationManager

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_pubpropertyDescription

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

System_CAPS_pubpropertyMetadataAddress

Gets or sets the discovery endpoint for obtaining metadata

System_CAPS_pubpropertyNotifications

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

System_CAPS_pubpropertyPostLogoutRedirectUri

Gets or sets the 'post_logout_redirect_uri'

System_CAPS_pubpropertyProtocolValidator

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

System_CAPS_pubpropertyRedirectUri

Gets or sets the 'redirect_uri'.

System_CAPS_pubpropertyRefreshOnIssuerKeyNotFound

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_pubpropertyResource

Gets or sets the 'resource'.

System_CAPS_pubpropertyResponseType

Gets or sets the 'response_type'.

System_CAPS_pubpropertyScope

Gets or sets the 'scope'.

System_CAPS_pubpropertySecurityTokenHandlers

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

System_CAPS_pubpropertySignInAsAuthenticationType

Gets or sets the AuthenticationType used when creating the ClaimsIdentity.

System_CAPS_pubpropertyStateDataFormat

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

System_CAPS_pubpropertyTokenValidationParameters

Gets or sets the TokenValidationParameters

System_CAPS_pubpropertyUseTokenLifetime

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.

NameDescription
System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

Return to top
Show: