flip/snowflake-promise
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/snowflake-promise.git synced 2026-02-06 03:07:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: formatting

Browse Source
This commit is contained in:
Nate Silva 2021-03-12 12:17:59 -08:00
parent b6a50d5e07
commit 29e025f753
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/types/ConnectionOptions.ts
View File

@ -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. */