Class BackOfficeExternalLoginProviderOptions
Options used to configure back office external login providers
Inheritance
Namespace: Umbraco.Cms.Web.BackOffice.Security
Assembly: Umbraco.Web.BackOffice.dll
Syntax
public class BackOfficeExternalLoginProviderOptions
Constructors
View SourceBackOfficeExternalLoginProviderOptions()
Declaration
public BackOfficeExternalLoginProviderOptions()
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 SourceAutoLinkOptions
Gets or sets 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 |
AutoRedirectLoginToExternalProvider
Gets or sets a value indicating whether 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.
ButtonColor
Gets or sets the color to use for the login button. See the UUI documentation for more details: https://uui.umbraco.com/?path=/story/uui-button--looks-and-colors.
Declaration
public UuiButtonColor ButtonColor { get; set; }
Property Value
Type | Description |
---|---|
UuiButtonColor |
Remarks
The default value is
ButtonLook
Gets or sets the look to use for the login button. See the UUI documentation for more details: https://uui.umbraco.com/?path=/story/uui-button--looks-and-colors.
Declaration
public UuiButtonLook ButtonLook { get; set; }
Property Value
Type | Description |
---|---|
UuiButtonLook |
Remarks
The default value is
ButtonStyle
Gets or sets the style of the login button.
Declaration
public string ButtonStyle { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
The default look is an outlined button, which has been optimized for the login screen.
CustomBackOfficeView
Gets or sets a virtual path to a custom JavaScript module that will be rendered in place of the default OAuth login buttons. The view can optionally replace the entire login screen if the DenyLocalLogin option is set to true.
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.
DenyLocalLogin
Gets or sets a value indicating whether when set to true will disable all local user login functionality. This is useful if you want to force users to login with an external provider.
Declaration
public bool DenyLocalLogin { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Icon
Gets or sets the icon to use for the login button. The standard icons of the Backoffice is available.
Declaration
public string Icon { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
It is possible to add custom icons to your provider by adding the icons to the
~/App_Plugins/{providerAlias}/icons
folder as SVG files. The icon name should be the same as the file name.