TSphinxConfig Class
Holds the configuration for the Sphinx server.
Remarks
TSphinxConfig is a key component for Sphinx to work properly. This is where most server configuration take place. Client applications should be registered using Clients property. Several options and events are also available.
Syntax
Unit: Sphinx.Comp.Config
TSphinxConfig = class(TComponent);Properties
| Name | Description |
|---|---|
| Clients | Holds the list of valid client applications. |
| ExternalLoginOptions | Gets or sets the external (upstream) identity reconciliation options used when Sphinx acts as an identity broker. |
| ExternalProviders | Holds the list of upstream (external) identity providers. |
| LockoutOptions | Gets or sets the lockout options. |
| LoginOptions | Gets or sets the login options. |
| PasswordHasher | Gets or sets the password hasher used to hash and verify user passwords. |
| PasswordOptions | Gets or sets the password options. |
| UIOptions | Gets or sets the UI options. |
| UserOptions | Gets or sets the user options. |
Events
| Name | Description |
|---|---|
| OnConfigureToken | Allows for customization of the generated access and identity token. |
| OnExternalSignIn | Event triggered after Sphinx has authenticated a user against an upstream (external) identity provider, to map the upstream identity to a local user. |
| OnExternalUserProvisioned | Event triggered when the built-in reconciliation policy provisions a brand new local user for an external (upstream) identity. |
| OnGenerateEmailConfirmationToken | Event triggered when an email confirmation token is generated and must be sent to the user. |
| OnGeneratePasswordResetToken | Event triggered when a password reset token is generated and must be sent to the user. |
| OnGeneratePhoneNumberConfirmationToken | Event triggered when a phone number confirmation token is generated and must be sent to the user. |
| OnGetClient | OnGetClient event is used to accept and configure client apps dynamically. |
| OnGetExternalProvider | Event used to accept and configure upstream (external) identity providers dynamically, the same way OnGetClient works for client applications. |
| OnGetSigningData | Event triggered when the signing data is requested. |
| OnListExternalProviders | Event used to choose which upstream providers are offered as interactive "Login with..." buttons on the login page, and in what order. |
| OnResolveExternalProvider | Event triggered for an authorization request with no active session, to decide whether Sphinx should delegate authentication to an upstream (external) identity provider. |
| OnUserCreated | Event triggered when a user is created. |
| OnUserEmailChanged | Event triggered when a user's email is changed. |
| OnUserEmailVerified | Event triggered when a user's email is verified. |
| OnUserPasswordChanged | Event triggered when a user's password is changed. |
| OnUserPhoneNumberChanged | Event triggered when a user's phone number is changed. |
| OnUserPhoneNumberVerified | Event triggered when a user's phone number is verified. |