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 ]
Copy

パラメーター

username

トークンが関連付けられているユーザーの名前。

username が省略された場合、コマンドは現在ログインしているユーザー(このセッションのアクティブユーザー)のプログラムによるアクセストークンを変更します。

MODIFY { PROGRAMMATIC ACCESS TOKEN | PAT } token_name

指定された名前のプログラムによるアクセストークンを変更します。

キーワード PROGRAMMATIC ACCESS TOKEN を指定する短い方法として、キーワード PAT を使うことができます。

RENAME TO new_token_name

プログラムによるアクセストークンの新しい名前を指定します。

SET ...

プログラムによるアクセストークンのために設定するプロパティを1つ(または複数)指定します(空白、コンマ、または改行で区切ります)。

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 ...

プログラムによるアクセストークンの1つまたは複数の指定されたプロパティまたはパラメーターの設定を解除します。これにより、プロパティはデフォルトにリセットされます。

  • DISABLED

  • MINS_TO_BYPASS_NETWORK_POLICY_REQUIREMENT

  • COMMENT

1つの 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;
Copy

プログラムによるアクセストークンに関連するコメントを変更します。

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