Home > @i2analyze/i2connect > services > IAuthenticatorConfig
services.IAuthenticatorConfig interface
A collection of properties that provide configuration for an authenticator.
Signature:
interface IAuthenticatorConfig<TAuthForm extends Record<string, IAuthenticationField>>
Introduced: API version 2.0
Type Parameters
| Parameter | Type | Description |
|---|---|---|
| TAuthForm | extends Record<string, IAuthenticationField> | The type of the form that the authenticator uses. |
Properties
| Property | Type | Description |
|---|---|---|
| description | string | Gets a description that the authenticator displays to tell users what to do in order to authenticate. |
| form | TAuthForm | Gets the authentication form to present to users. |
| id | string | Gets the identifier of the authenticator, which can be referenced by services. |