ALTER USER ... MODIFY PROGRAMMATIC ACCESS TOKEN (PAT)¶

更改编程访问令牌的名称或令牌的属性。

备注

在使用编程访问令牌进行身份验证的会话中，您无法修改或重命名编程访问令牌。

另请参阅：: ALTER USER ... ADD PROGRAMMATIC ACCESS TOKEN (PAT)、ALTER USER ... ROTATE PROGRAMMATIC ACCESS TOKEN (PAT)、ALTER USER ... REMOVE PROGRAMMATIC ACCESS TOKEN (PAT)、SHOW USER PROGRAMMATIC ACCESS TOKENS

语法¶

ALTER USER [ IF EXISTS ] [ <username> ] MODIFY { PROGRAMMATIC ACCESS TOKEN | PAT } <token_name>
  RENAME TO <new_token_name>

ALTER USER [ IF EXISTS ] [ <username> ] MODIFY { PROGRAMMATIC ACCESS TOKEN | PAT } <token_name> SET
  [ DISABLED = { TRUE | FALSE } ]
  [ MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT = <integer> ]
  [ COMMENT = '<string_literal>' ]

ALTER USER [ IF EXISTS ] [ <username> ] MODIFY { PROGRAMMATIC ACCESS TOKEN | PAT } <token_name> UNSET
  [ DISABLED ]
  [ MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT ]
  [ COMMENT ]

参数¶

username

与令牌关联的用户的名称。

如果省略 username，该命令将为当前登录的用户（此会话的活跃用户）修改编程访问令牌。

MODIFY { PROGRAMMATIC ACCESS TOKEN | PAT } token_name

修改具有指定名称的编程访问令牌。

您可以使用关键字 PAT 作为指定关键字 PROGRAMMATIC ACCESS TOKEN 的简便方法。

RENAME TO new_token_name

为编程访问令牌指定新名称。

SET ...

指定要为编程访问令牌设置的一个（或多个）属性（用空格、逗号或新行分隔）：

DISABLED = { TRUE | FALSE }

禁用或启用编程访问令牌。

如果用户被禁用或 Snowflake 锁定用户，则与该用户相关联的编程令牌将自动禁用。如果该用户随后被启用或 Snowflake 解锁该用户，编程访问令牌也仍然保持禁用状态。要再次启用令牌，请将 DISABLED 设置为 FALSE。

有关信息，请参阅重新启用已禁用的编程访问令牌。

MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT = integer

用户在此时间段内（以分钟为单位）可使用该令牌访问 Snowflake，而不受有效网络策略的约束。

如果某人不受网络策略约束，但需要使用编程访问令牌进行身份验证，则可以为该人设置令牌（如果 USER 对象为 TYPE=PERSON）。请参阅网络策略要求。

备注

设置 MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT 不允许用户绕过网络策略本身。

您可以将其设置为介于 1 到 ``1440``（1 天）范围内的值。

默认：0

COMMENT = 'string_literal': 关于编程访问令牌的描述性注释。此注释显示在 Snowsight 中的编程访问令牌列表中。

UNSET ...

取消为编程访问令牌设置的一个或多个指定属性或参数，并将这些属性重置为其默认值：

DISABLED
MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT
COMMENT

要使用单个 ALTER 语句取消设置多个属性或参数，请使用逗号分隔每个属性或参数。

取消设置属性或参数时，只指定属性或参数名称（除非上述语法表明您应该指定值）。指定值会返回错误。

访问控制要求¶

用于执行此操作的角色必须至少具有以下权限：


权限	对象	备注
MODIFY PROGRAMMATIC AUTHENTICATION METHODS	用户	仅在为除您自己或服务用户之外的人类用户修改编程访问令牌时需要。

有关创建具有指定权限集的自定义角色的说明，请参阅创建自定义角色。

有关对安全对象执行 SQL 操作的相应角色和权限授予的一般信息，请参阅访问控制概述。

使用说明¶

在使用编程访问令牌进行身份验证的会话中，您无法修改或重命名编程访问令牌。

示例¶

更改与用户 example_user 关联的编程访问令牌的名称：

ALTER USER IF EXISTS example_user MODIFY PROGRAMMATIC ACCESS TOKEN old_token_name
  RENAME TO new_token_name;

更改与编程访问令牌相关的评论：

ALTER USER IF EXISTS example_user MODIFY PROGRAMMATIC ACCESS TOKEN token_name
  SET COMMENT = 'my new comment';