Categories:

System functions (System Information)

SYSTEM$VERIFY_EXTERNAL_OAUTH_TOKEN

Determines whether your External OAuth access token is valid or has expired and needs to be regenerated.

语法

SYSTEM$VERIFY_EXTERNAL_OAUTH_TOKEN( '<access_token>' )

实参

access_token

由 OAuth 2.0 服务器生成的 External OAuth 访问令牌。

输出

该函数返回 JSON 对象,该对象说明验证结果和原因。查询结果不应显示令牌本身。例如,无效令牌应在结果中返回掩码令牌,以确保敏感信息不会在 Snowflake 中不必要地公开。

Column NameData TypeDescription
Validation ResultStringA valid token returns Passed.
An invalid token returns Failed.
ReasonStringA valid token returns the Issuer URL and the user.
An invalid token states the problem with the access token (e.g. EXTERNAL_OAUTH_JWS_INVALID_FORMAT).

示例

以下示例返回有效 External OAuth 令牌结果:

SELECT SYSTEM$VERIFY_EXTERNAL_OAUTH_TOKEN('<access_token>');

+-----------------------------------------------------------------------------------------------+
| Token Validation finished.{"Validation Result":"Passed","Issuer":"<URL>","User":"<username>"} |
+-----------------------------------------------------------------------------------------------+