Class ExternalLoginProvider

Namespace

Dynamicweb.Security.UserManagement.ExternalAuthentication

Assembly

Dynamicweb.Security.dll

Represents a base class for implmenting external login providers.

[AddInName("ExternalLoginProvider")]
[AddInDescription("Base External Login provider")]
[AddInIgnore(true)]
public abstract class ExternalLoginProvider : ConfigurableAddIn

Inheritance

object

ConfigurableAddIn

ExternalLoginProvider

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AddInInstance

External Login Provider Configurable AddIn instance.

public ConfigurableAddIn AddInInstance { get; }

Property Value

ConfigurableAddIn

CreateLocalAccountWithoutPage

If set to true local user will be created by External Login account info. If set to false the CreateNewUserPage will be shown for the new local user creation.

[AddInLabel("Create local account without showing the \"create new user\" page ")]
[AddInParameter("CreateLocalAccountWithoutPage")]
[AddInParameterEditor("Dynamicweb.Extensibility.Editors.YesNoParameterEditor, Dynamicweb", "")]
public virtual bool CreateLocalAccountWithoutPage { get; set; }

Property Value

bool

CreateNewUserPage

Gets or sets the page to redirect to when the user logs in with External Login account and doesn't have a Dynamicweb account. This page should contain the paragraph with Extranet module on it configured to new user creation.

[AddInLabel("Create new user page")]
[AddInParameter("CreateNewUserPage")]
[AddInParameterEditor("Dynamicweb.Extensibility.Editors.PageSelectEditor, Dynamicweb", "")]
public virtual string CreateNewUserPage { get; set; }

Property Value

string

Icon

Gets the icon class name for the provider.

public virtual string Icon { get; }

Property Value

string

Name

Gets the name of the provider.

public string Name { get; }

Property Value

string

NewUserGroups

Groups assigned to the new user created by External Login account info.

[AddInLabel("Groups for new users")]
[AddInParameter("NewUserGroups")]
[AddInParameterEditor("Dynamicweb.Extensibility.Editors.UserGroupParameterEditor, Dynamicweb", "multiple=true")]
public virtual string NewUserGroups { get; set; }

Property Value

string

OnlyDoVerificationExternally

When set, only username and password validation is handled externally. If external validation succeeds, the dynamicweb user with the matching Username is logged in.

public bool OnlyDoVerificationExternally { get; set; }

Property Value

bool

PageID

The ID of the page from where the login has started. Only contains a value if a field with name ID has been posted to ExternalLogin.aspx.

public int PageID { get; }

Property Value

int

ProviderID

Returns the login provider id

public int ProviderID { get; set; }

Property Value

int

RedirectUrl

Returns url to redirect to after the login request is made.

public virtual string RedirectUrl { get; }

Property Value

string

ReturnUrl

Returns url to redirect to after successful login.

public virtual string ReturnUrl { get; }

Property Value

string

Methods

GetLoginResult()

Returns the login result from the external login platform.

public abstract ExternalLoginResult GetLoginResult()

Returns

ExternalLoginResult

Login()

Makes the login request to the external login platform.

public abstract void Login()

Render(object)

Renders provider specific tags to the specified temmplate instance.

public virtual void Render(object templateInstance)

Parameters

templateInstance object

The temmplate instance.

Remarks

Override this method to add own template tags to the login template. The render method is passed object template, and should be castet to Dynamicweb.Rendering.Template (Dynamicweb.dll) to set tags on the rendering instance.