ALTER SECRET¶

既存のシークレットのプロパティを変更します。

こちらもご参照ください。: CREATE SECRET、 DESCRIBE SECRET、 DROP SECRET、 SHOW SECRETS

構文¶

クライアント認証情報フローを使用した OAuth:

ALTER SECRET [ IF EXISTS ] <name> SET [ OAUTH_SCOPES = ( '<scope_1>' [ , '<scope_2>' ... ] ) ]
                                      [ COMMENT = '<string_literal>' ]

ALTER SECRET [ IF EXISTS ] <name> UNSET COMMENT

Copy

認証コード付与フローを使用した OAuth:

ALTER SECRET [ IF EXISTS ] <name> SET [ OAUTH_REFRESH_TOKEN = '<token>' ]
                                      [ OAUTH_REFRESH_TOKEN_EXPIRY_TIME = '<string_literal>' ]
                                      [ COMMENT = '<string_literal>' ]

ALTER SECRET [ IF EXISTS ] <name> UNSET COMMENT

Copy

基本認証:

ALTER SECRET [ IF EXISTS ] <name> SET [ USERNAME = '<username>' ]
                                      [ PASSWORD = '<password>' ]
                                      [ COMMENT = '<string_literal>' ]

ALTER SECRET [ IF EXISTS ] <name> UNSET COMMENT

Copy

一般的な文字列:

ALTER SECRET [ IF EXISTS ] <name> SET [ SECRET_STRING = '<string_literal>' ]
                                      [ COMMENT = '<string_literal>' ]

ALTER SECRET [ IF EXISTS ] <name> UNSET COMMENT

Copy

クライアント認証情報フローパラメーターを使用した OAuth¶

name

シークレットの識別子（つまり、名前）を指定する文字列。スキーマ内で一意である必要があります。

SET ...

設定する1つ（または複数）のパラメーターを指定します（空白、コンマ、または改行で区切ります）。

OAUTH_SCOPES = ( 'scope_1' [ , 'scope_2' ... ] )

OAuth クライアント認証情報フロー中に、統合に対して USAGE を持つロールによって OAuth サーバーからリクエストする際に使用するスコープのコンマ区切りリストを指定します。

このリストは、セキュリティ統合の OAUTH_ALLOWED_SCOPES プロパティで定義されたスコープのサブセットである必要があります。 OAUTH_SCOPES プロパティ値が指定されていない場合、シークレットはセキュリティ統合で指定されているすべてのスコープを継承します。

認証コード付与フローパラメーターを使用した OAuth¶

name

シークレットの識別子（つまり、名前）を指定する文字列。スキーマ内で一意である必要があります。

SET ...

設定する1つ（または複数）のパラメーターを指定します（空白、コンマ、または改行で区切ります）。

OAUTH_REFRESH_TOKEN = 'token': アクセストークンの有効期限が切れたときに OAuth 認証サーバーから新しいアクセストークンを取得するために使用される文字列としてトークンを指定します。
OAUTH_REFRESH_TOKEN_EXPIRY_TIME = 'string_literal': OAuth 更新トークンの有効期限が切れたときのタイムスタンプを文字列として指定します。

基本認証パラメーター¶

name

シークレットの識別子（つまり、名前）を指定する文字列。スキーマ内で一意である必要があります。

SET ...

セッションに設定する1つ（または複数）のパラメーターを指定します（空白、コンマ、または改行で区切られます）。

USERNAME = 'username'

シークレットに保存するユーザー名の値を指定します。

基本認証にシークレットを使用する場合は、このプロパティ値を指定します（つまり、シークレットは TYPE = PASSWORD です）。

PASSWORD = 'password'

シークレットに保存するパスワード値を指定します。

基本認証にシークレットを使用する場合は、このプロパティ値を指定します（つまり、シークレットは TYPE = PASSWORD です）。

一般的な文字列パラメーター¶

name

シークレットの識別子（つまり、名前）を指定する文字列。スキーマ内で一意である必要があります。

SET ...

設定する1つ（または複数）のパラメーターを指定します（空白、コンマ、または改行で区切ります）。

SECRET_STRING = 'string_literal'

シークレットに保存する文字列を指定します。

文字列は API トークンであるか、 UDF またはストアドプロシージャのハンドラーコードで使用できる機密性の高い値の文字列です。詳細については、外部アクセス統合の作成と使用をご参照ください。

このプロパティは、 OAuth トークンの保存には使用しないでください。 OAuth のユースケースには、他のシークレットタイプを使用してください。

共通パラメーター: すべての構文¶

SET ...

セッションに設定する1つ（または複数）のパラメーターを指定します（空白、コンマ、または改行で区切られます）。

COMMENT = 'string_literal'

シークレットのコメントを指定する文字列（リテラル）。

デフォルト: 値なし

UNSET ...

シークレットの設定を解除する1つ（またはそれ以上）のプロパティ/パラメーターを指定し、それらをデフォルトにリセットします。

COMMENT

アクセス制御の要件¶

この SQL コマンドの実行に使用されるロールには、少なくとも次の権限が必要です。

権限	オブジェクト	メモ
OWNERSHIP	シークレット	OWNERSHIP is a special privilege on an object that is automatically granted to the role that created the object, but can also be transferred using the GRANT OWNERSHIP command to a different role by the owning role (or any role with the MANAGE GRANTS privilege).

スキーマ内の任意のオブジェクトを操作するには、親データベースとスキーマに対する USAGE 権限も必要であることに注意してください。

指定された権限のセットを使用してカスタムロールを作成する手順については、カスタムロールの作成をご参照ください。

セキュリティ保護可能なオブジェクトに対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、アクセス制御の概要をご参照ください。

使用上の注意¶

メタデータについて:

注意

Snowflakeサービスを使用する場合、お客様は、個人データ（ユーザーオブジェクト向け以外）、機密データ、輸出管理データ、またはその他の規制されたデータがメタデータとして入力されていないことを確認する必要があります。詳細については、 Snowflakeのメタデータフィールドをご参照ください。

例¶

シークレットのコメントを修正します:

ALTER SECRET service_now_creds_pw SET COMMENT = 'production secret for servicenow';

Copy