Class HubAuthenticationModule

The HUB authentication module.

Inheritance

System.Object

HubAuthenticationModule

Implements

System.Web.IHttpModule

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TheIdentityHub

Assembly: TheIdentityHub.dll

Syntax

public sealed class HubAuthenticationModule : IHttpModule

Methods

CreateAuthenticateRedirectUrl(HttpRequest, Uri)

Creates a URL to redirect and start the login flow.

Declaration

public static string CreateAuthenticateRedirectUrl(HttpRequest httpRequest, Uri replyUrl)

Parameters

Type	Name	Description
System.Web.HttpRequest	httpRequest	The HTTP request.
System.Uri	replyUrl	The reply URL to redirect to after successful logon.

Returns

Type	Description
System.String	The constructed URL to redirect to to start the login flow.

CreateAuthenticateRedirectUrl(HttpRequest, Uri, String)

Creates a URL to redirect and start the login flow.

Declaration

public static string CreateAuthenticateRedirectUrl(HttpRequest httpRequest, Uri replyUrl, string accountProviderId)

Parameters

Type	Name	Description
System.Web.HttpRequest	httpRequest	The HTTP request.
System.Uri	replyUrl	The reply URL to redirect to after successful logon.
System.String	accountProviderId	The account provider identifier.

Returns

Type	Description
System.String	The constructed URL to redirect to to start the login flow.

CreateAuthenticateRedirectUrl(HttpRequestBase, Uri)

Creates a URL to redirect and start the login flow.

Declaration

public static string CreateAuthenticateRedirectUrl(HttpRequestBase httpRequest, Uri replyUrl)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request.
System.Uri	replyUrl	The reply URL to redirect to after successful logon.

Returns

Type	Description
System.String	The constructed URL to redirect to to start the login flow.

CreateAuthenticateRedirectUrl(HttpRequestBase, Uri, String)

Creates a URL to redirect and start the login flow.

Declaration

public static string CreateAuthenticateRedirectUrl(HttpRequestBase httpRequest, Uri replyUrl, string accountProviderId)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request.
System.Uri	replyUrl	The reply URL to redirect to after successful logon.
System.String	accountProviderId	The account provider identifier.

Returns

Type	Description
System.String	The constructed URL to redirect to to start the login flow.

Dispose()

Disposes of the resources (other than memory) used by the module that implements System.Web.IHttpModule.

Declaration

public void Dispose()

Init(HttpApplication)

Initializes a module and prepares it to handle requests.

Declaration

public void Init(HttpApplication context)

Parameters

Type	Name	Description
System.Web.HttpApplication	context	An System.Web.HttpApplication that provides access to the methods, properties, and events common to all application objects within an ASP.NET application

SignIn()

Triggers the sign in flow.

Declaration

public static void SignIn()

SignIn(String, String)

Performs a sign in of a user based on username/password credentials.

Declaration

public static string SignIn(string username, string password)

Parameters

Type	Name	Description
System.String	username	The username.
System.String	password	The password.

Returns

Type	Description
System.String	The identity identifier.

SignOut()

Triggers the sign out flow.

Declaration

public static void SignOut()

SignOut(String)

Trigger sign out flow and performs slo to The Identity Hub.

Declaration

public static void SignOut(string returnUrl)

Parameters

Type	Name	Description
System.String	returnUrl	The return URL.

TrySignIn(String, String, out String)

Performs a sign in of a user based on username/password credentials.

Declaration

public static bool TrySignIn(string username, string password, out string identityId)

Parameters

Type	Name	Description
System.String	username	The username.
System.String	password	The password.
System.String	identityId	The identity identifier.

Returns

Type	Description
System.Boolean	true if success, false otherwise.

Implements

System.Web.IHttpModule