- 类别:
系统函数 (系统控制)
SYSTEM$START_OAUTH_FLOW¶
启动 OAUTH 客户端流程,返回在浏览器中使用的 URL,以完成 OAuth 同意过程。
语法¶
SYSTEM$START_OAUTH_FLOW( '<database_name.schema_name.secret_name>' )
实参¶
'database_name.schema_name.secret_name'
OAuth2 密钥的名称,指定供 API 用于通过 OAuth 进行访问的身份验证信息。
使用说明¶
使用此函数启动一个流程,将 OAuth 刷新令牌添加到作为实参传递给此函数的密钥中。
作为中间步骤,此函数返回一个授权 URL,您可以在浏览器中使用它来完成 OAuth 同意过程。
执行此函数并使用其返回的 URL 后,立即在同一会话中执行 SYSTEM$FINISH_OAUTH_FLOW,以让 Snowflake 向您指定的密钥添加刷新令牌。
此函数实参中的 密钥 必须包含:
一个 TYPE 参数,用于指定
oauth2
的值。一个 API_AUTHENTICATION 参数,用于指定 安全集成,其中包含正为其授予访问权限的服务提供商的相关详细信息(如 OAuth 客户端 ID、密钥、授权端点和令牌端点)。