View Source

Class AuthenticationOptionsExtensions

Inheritance

System.Object

Namespace: Umbraco.Web.Security

Assembly: Umbraco.Web.dll

Syntax

public static class AuthenticationOptionsExtensions

Methods

ForUmbracoBackOffice(AuthenticationOptions, String, String, String)

Configures the properties of the authentication description instance for use with Umbraco back office

Declaration

public static void ForUmbracoBackOffice(this AuthenticationOptions options, string style, string icon, string callbackPath = null)

Parameters

Type	Name	Description
AuthenticationOptions	options
System.String	style
System.String	icon
System.String	callbackPath	This is important if the identity provider is to be able to authenticate when upgrading Umbraco. We will try to extract this from any options passed in via reflection since none of the default OWIN providers inherit from a base class but so far all of them have a consistent name for the 'CallbackPath' property which is of type PathString. So we'll try to extract it if it's not found or supplied. If a value is extracted or supplied, this will be added to an internal list which the UmbracoModule will use to allow the request to pass through without redirecting to the installer.

GetExternalAuthenticationOptions(AuthenticationDescription)

Declaration

[Obsolete("Use GetExternalSignInAutoLinkOptions instead")]
public static ExternalSignInAutoLinkOptions GetExternalAuthenticationOptions(this AuthenticationDescription authenticationDescription)

Parameters

Type	Name	Description
AuthenticationDescription	authenticationDescription

Returns

Type	Description
ExternalSignInAutoLinkOptions

GetExternalSignInAutoLinkOptions(AuthenticationDescription)

Declaration

public static ExternalSignInAutoLinkOptions GetExternalSignInAutoLinkOptions(this AuthenticationDescription authenticationDescription)

Parameters

Type	Name	Description
AuthenticationDescription	authenticationDescription

Returns

Type	Description
ExternalSignInAutoLinkOptions

GetSignInChallengeResult(AuthenticationDescription, IOwinContext)

Declaration

public static AuthenticationProperties GetSignInChallengeResult(this AuthenticationDescription authenticationDescription, IOwinContext ctx)

Parameters

Type	Name	Description
AuthenticationDescription	authenticationDescription
IOwinContext	ctx

Returns

Type	Description
AuthenticationProperties

SetBackOfficeExternalLoginProviderOptions(AuthenticationOptions, BackOfficeExternalLoginProviderOptions)

Used to specify all back office external login options

Declaration

public static void SetBackOfficeExternalLoginProviderOptions(this AuthenticationOptions authOptions, BackOfficeExternalLoginProviderOptions externalLoginProviderOptions)

Parameters

Type	Name	Description
AuthenticationOptions	authOptions
BackOfficeExternalLoginProviderOptions	externalLoginProviderOptions

SetExternalSignInAutoLinkOptions(AuthenticationOptions, ExternalSignInAutoLinkOptions)

Declaration

[Obsolete("Use SetBackOfficeExternalLoginProviderOptions instead")]
public static void SetExternalSignInAutoLinkOptions(this AuthenticationOptions authOptions, ExternalSignInAutoLinkOptions options)

Parameters

Type	Name	Description
AuthenticationOptions	authOptions
ExternalSignInAutoLinkOptions	options

SetSignInChallengeResultCallback(AuthenticationOptions, Func<IOwinContext, AuthenticationProperties>)

Declaration

[Obsolete("Use SetBackOfficeExternalLoginProviderOptions instead")]
public static void SetSignInChallengeResultCallback(this AuthenticationOptions authOptions, Func<IOwinContext, AuthenticationProperties> authProperties)

Parameters

Type	Name	Description
AuthenticationOptions	authOptions
System.Func<IOwinContext, AuthenticationProperties>	authProperties