カテゴリ:

システム関数 (システム制御)

SYSTEM$START_OAUTH_FLOW

OAUTH クライアントフローを開始し、OAuth 同意プロセスを完了するためにブラウザーで使用する URL を返します。

構文

SYSTEM$START_OAUTH_FLOW( '<database_name.schema_name.secret_name>' )
Copy

引数

'database_name.schema_name.secret_name'

API が OAuth でアクセスするための認証情報を指定する OAuth2 シークレットの名前。

使用上の注意

この関数を使用して、引数としてこの関数に渡したシークレットに OAuth 更新トークンが追加されるフローを開始します。

中間ステップとして、この関数はブラウザーで OAuth 同意プロセスを完了させることができる認証 URL を返します。

この関数を実行して URL を返した後、すぐに同じセッションで SYSTEM$FINISH_OAUTH_FLOW を実行して、Snowflakeに指定したシークレットに更新トークンを追加させます。

この関数の引数に シークレット を含める必要があります。

  • oauth2 の値を指定する TYPE パラメーター。

  • API_AUTHENTICATION パラメーターには、 セキュリティ統合 を指定するもので、アクセスを許可するサービスプロバイダーの詳細(OAuth クライアント ID、シークレット、認可エンドポイント、トークンエンドポイントなど)を含まれています。