diff --git a/README.md b/README.md index b04c6838..6e232bd5 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,6 @@ account, [follow these instructions](https://docs.snowflake.com/en/user-guide/or export SNOWFLAKE_ROLE="" export SNOWFLAKE_WAREHOUSE="" export SNOWFLAKE_USER="" -export SNOWFLAKE_PASSWORD="" export SNOWFLAKE_ACCOUNT_LOCATOR="" export SNOWFLAKE_HOST="" ``` @@ -49,7 +48,6 @@ export SNOWFLAKE_HOST="" set SNOWFLAKE_ROLE= set SNOWFLAKE_WAREHOUSE= set SNOWFLAKE_USER= -set SNOWFLAKE_PASSWORD= set SNOWFLAKE_ACCOUNT_LOCATOR= set SNOWFLAKE_HOST= ``` @@ -63,15 +61,33 @@ import os os.environ['SNOWFLAKE_ROLE'] = '' os.environ['SNOWFLAKE_WAREHOUSE'] = '' os.environ['SNOWFLAKE_USER'] = '' -os.environ['SNOWFLAKE_PASSWORD'] = '' os.environ['SNOWFLAKE_ACCOUNT_LOCATOR'] = '' os.environ['SNOWFLAKE_HOST'] = '' ``` -4. If you are using single sign-on authetication, you can leave password empty and set additional environ below: +Our semantic model generators currently support three types of authentication. If no `SNOWFLAKE_AUTHENTICATOR` +environment variable +is set, the default is `snowflake`, which uses standard username/password support. + +1. Username and Password + +```bash +# no SNOWFLAKE_AUTHENTICATOR needed +export SNOWFLAKE_PASSWORD="" +``` + +2. Username/Password with MFA - ```python -os.environ['SNOWFLAKE_AUTHENTICATOR'] = 'EXTERNALBROWSER' +```bash +export SNOWFLAKE_AUTHENTICATOR="username_password_mfa" +export SNOWFLAKE_PASSWORD="" +``` + +3. Single Sign-On (SSO) with Okta + +```bash +# no SNOWFLAKE_PASSWORD needed +export SNOWFLAKE_AUTHENTICATOR="externalbrowser" ``` ## Usage