TListExternalProvidersArgs Class

Arguments passed to the TSphinxConfig.OnListExternalProviders event, fired when the login page needs the list of upstream providers to offer as interactive "Login with..." options.

Remarks

The list is pre-seeded with the names of the providers registered in TSphinxConfig.ExternalProviders whose TSphinxExternalProvider.ShowInLoginPage is True. The handler may add names (including providers not registered statically, materialized on the fly by TSphinxConfig.OnGetExternalProvider), remove names, or reorder them, based on ClientId and TenantId. This event deals only with which provider names appear and in what order; each provider's properties (display name, icon, endpoints, secret) always come from OnGetExternalProvider, so they are never specified twice.

Syntax

Unit: Sphinx.Comp.Config

TListExternalProvidersArgs = class(TObject);

Properties

Name	Description
ClientId	The client id of the application the user is logging in to.
ProviderNames	The ordered list of provider names to offer on the login page. Mutate it directly to add, remove or reorder entries (e.g. ProviderNames.Add('google')).
TenantId	The resolved tenant id for the request, or empty when no tenant applies.