IExternalLinkedAuthenticationProviderController (v2) Plugin Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:13:25 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:13:25

IExternalLinkedAuthenticationProviderController is defined in the Telligent.Evolution.Extensibility.Authentication.Version2 namespace of Telligent.Evolution.Platform.dll

Definition

interface IExternalLinkedAuthenticationProviderController
{
	Func<string> ClientLogoutHtml { set;  }
	Func<string> CssColor { set;  }
	Func<string> IconUrl { set;  }
	Func<string> PrivacyDetailsHtml { set;  }
	string RegisterAndGetCallbackUrl(Func<[[ExternalLinkedAuthenticationCallbackOptions (v2) Plugin Supplementary Type|ExternalLinkedAuthenticationCallbackOptions]],Task> handler);
	void SetLinkedUserData([[ExternalLinkedAuthenticationUserData (v2) Plugin Supplementary Type|ExternalLinkedAuthenticationUserData]] data, string state);
}

Properties

Name	Type	Description
ClientLogoutHtml	`Func<string>`	A client-side script to execute when a user logs out after being authenticated by this provider.
CssColor	`Func<string>`	The color used for styling the presentation of this provider in the UI.
IconUrl	`Func<string>`	The URL of an icon to identify this provider.
PrivacyDetailsHtml	`Func<string>`	Details about the privacy of using this provider.

Methods

string RegisterAndGetCallbackUrl(Func<ExternalLinkedAuthenticationCallbackOptions,Task> handler);

Registers a handler for the shared callback URL that is suitable to provide to OAuth-based external authentication stores as the Redirect URI. The URL returned is unique to this provider can can be shared with end-users to help them configure external integrations.

Parameters

Name	Type	Description	Required	Default	Options
handler	`Func<[[ExternalLinkedAuthenticationCallbackOptions (v2) Plugin Supplementary Type\|ExternalLinkedAuthenticationCallbackOptions]],Task>`	Handler	Required

Return Type

string

void SetLinkedUserData(ExternalLinkedAuthenticationUserData data, string state);

The end of the external provider's authentication workflow. Provides the authenticated user information and the state originally provided to GetInitializeUrl().

Parameters

Name	Type	Description	Required	Default	Options
data	`[[ExternalLinkedAuthenticationUserData (v2) Plugin Supplementary Type\|ExternalLinkedAuthenticationUserData]]`	Data	Required
state	`string`	State	Required