Home > @i2analyze/i2connect > authenticator
authenticator() function
The @authenticator
decorator, which configures a method on the connector class to perform user authentication.
Signature:
export declare function authenticator(config: connectors.IAuthenticatorConfig): MethodDecorator;
Introduced: API version 1.0
Parameters
Parameter | Type | Description |
---|---|---|
config | connectors.IAuthenticatorConfig | Settings that provide an identifier and a description for the authenticator. |
Returns:
MethodDecorator
Example
@authenticator({ id: 'usernameAndPasswordConfigId', description: 'Enter your user name and password' })
usernameAndPasswordAuthConfig (...)