TResolveExternalProviderArgs Class

Arguments passed to the OnResolveExternalProvider event, fired when an authorization request has no active session and Sphinx must decide whether to delegate authentication to an upstream (external) identity provider.

Remarks

The event handler inspects the request properties exposed here (ClientId, Scope, Prompt, TenantId) and, if it wants Sphinx to act as an identity broker for this request, sets ProviderName to the name of a provider registered in TSphinxConfig.ExternalProviders. Leaving ProviderName empty makes Sphinx fall back to its normal interactive login. Any request data not exposed here can still be read from the underlying request via TSphinxModuleArgs.Handler.

Syntax

Unit: Sphinx.EventArgs

TResolveExternalProviderArgs = class(TSphinxModuleArgs);

Properties

Name	Description
ClientId	The client id of the application that initiated the authorization request.
Prompt	The OpenID Connect prompt parameter of the authorization request, if any.
ProviderName	The name of the upstream provider to delegate this request to. Empty (the default) means no delegation: Sphinx handles the request with its normal interactive login.
Scope	The space-separated scopes requested in the authorization request.
TenantId	The resolved tenant id for the request, or empty when no tenant applies.