Home > @i2analyze/i2connect > connectors > IAuthenticatorConfig > description

connectors.IAuthenticatorConfig.description property

Gets a description that the authenticator displays to tell users what to do in order to authenticate.

Signature:

readonly description: string;

Returns: string

Introduced: API version 1.0

Remarks

The description string can contain simple markup that enables the inclusion of hyperlinks.

Example

A description that contains a hyperlink might look like this:

Enter a user name and a password. In this example, the password must match the user name. For more information, [hyperlink]http://example.com/passwords click here[/hyperlink].