View Source

Class BackOfficeExternalLoginProviderOptions

Options used to configure back office external login providers

Inheritance
System.Object
Namespace: Umbraco.Cms.Web.BackOffice.Security
Assembly: Umbraco.Web.BackOffice.dll
Syntax
public class BackOfficeExternalLoginProviderOptions

Constructors

View Source

BackOfficeExternalLoginProviderOptions()

Declaration
public BackOfficeExternalLoginProviderOptions()
View Source

BackOfficeExternalLoginProviderOptions(String, String, ExternalSignInAutoLinkOptions, Boolean, Boolean, String)

Declaration
public BackOfficeExternalLoginProviderOptions(string buttonStyle, string icon, ExternalSignInAutoLinkOptions autoLinkOptions = null, bool denyLocalLogin = false, bool autoRedirectLoginToExternalProvider = false, string customBackOfficeView = null)
Parameters
Type Name Description
System.String buttonStyle
System.String icon
ExternalSignInAutoLinkOptions autoLinkOptions
System.Boolean denyLocalLogin
System.Boolean autoRedirectLoginToExternalProvider
System.String customBackOfficeView

Properties

View Source

AutoLinkOptions

Options used to control how users can be auto-linked/created/updated based on the external login provider

Declaration
public ExternalSignInAutoLinkOptions AutoLinkOptions { get; set; }
Property Value
Type Description
ExternalSignInAutoLinkOptions
View Source

AutoRedirectLoginToExternalProvider

When specified this will automatically redirect to the OAuth login provider instead of prompting the user to click on the OAuth button first.

Declaration
public bool AutoRedirectLoginToExternalProvider { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This is generally used in conjunction with DenyLocalLogin. If more than one OAuth provider specifies this, the last registered provider's redirect settings will win.

View Source

ButtonStyle

Declaration
public string ButtonStyle { get; set; }
Property Value
Type Description
System.String
View Source

CustomBackOfficeView

A virtual path to a custom angular view that is used to replace the entire UI that renders the external login button that the user interacts with

Declaration
public string CustomBackOfficeView { get; set; }
Property Value
Type Description
System.String
Remarks

If this view is specified it is 100% up to the user to render the html responsible for rendering the link/un-link buttons along with showing any errors that occur. This overrides what Umbraco normally does by default.

View Source

DenyLocalLogin

When set to true will disable all local user login functionality

Declaration
public bool DenyLocalLogin { get; set; }
Property Value
Type Description
System.Boolean
View Source

Icon

Declaration
public string Icon { get; set; }
Property Value
Type Description
System.String