diff --git a/src/types/ConnectionOptions.ts b/src/types/ConnectionOptions.ts index 9c25af7..dd6eaec 100644 --- a/src/types/ConnectionOptions.ts +++ b/src/types/ConnectionOptions.ts @@ -13,15 +13,23 @@ export interface ConnectionOptions { /** * Specifies the authenticator to use for verifying user login credentials. * You can set this to one of the following values: - * SNOWFLAKE: Use the internal Snowflake authenticator. You must also set the password option. - * EXTERNALBROWSER: Use your web browser to authenticate with Okta, ADFS, or any other - * SAML 2.0-compliant identity provider (IdP) that has been defined for your account - * OAUTH: Use OAuth for authentication. You must also set the token option to the OAuth token - * SNOWFLAKE_JWT: Use key pair authentication + * + * * `SNOWFLAKE`: Use the internal Snowflake authenticator. You must also set the + * password option. + * + * * `EXTERNALBROWSER`: Use your web browser to authenticate with Okta, ADFS, or any + * other SAML 2.0-compliant identity provider (IdP) that has been defined for your + * account + * + * * `OAUTH`: Use OAuth for authentication. You must also set the token option to the + * OAuth token + * + * * `SNOWFLAKE_JWT`: Use key pair authentication */ - /** Password for the user. Set this option if you set the authenticator option to - * SNOWFLAKE or if you left the authenticator option unset. authenticator?: "SNOWFLAKE" | "EXTERNALBROWSER" | "OAUTH" | "SNOWFLAKE_JWT"; + /** + * Password for the user. Set this option if you set the authenticator option to + * SNOWFLAKE or if you left the authenticator option unset. */ password?: string; /** Specifies the OAuth token to use for authentication. */