Enable optionally authenticating via an external authentication store.
IExternalLinkedAuthenticationProvider
is defined in the Telligent.Evolution.Extensibility.Authentication.Version2
namespace of Telligent.Evolution.Platform.dll
Definition
interface IExternalLinkedAuthenticationProvider : IPlugin { string Id { get; } string NameHtml { get; } Task<string> GetInitializeUrl(ExternalLinkedAuthenticationInitializeOptions options); void SetController(IExternalLinkedAuthenticationProviderController controller); }
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Id | string | The internal ID of the external authentication provider. Alphanumeric without spaces. | ||
NameHtml | string | The user-presented name of this provider. |
Methods
Task<string> GetInitializeUrl(ExternalLinkedAuthenticationInitializeOptions options);
Returns a URL to the external resource to initiate the external authentication workflow. The provided state should be persisted through the end of the workflow and returned to Community.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | ExternalLinkedAuthenticationInitializeOptions | Options | Required |
Return Type
Task<string>
void SetController(IExternalLinkedAuthenticationProviderController controller);
Provides the controller to provide optional configuration and callbacks.
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
controller | IExternalLinkedAuthenticationProviderController | Controller | Required |