Atlas組織は apiKeys を割り当てます

項目一覧

構文

Arguments
オプション
継承されたオプション
出力
例

指定された組織 API キーのロールまたは説明を変更します。

このコマンドを使用して組織 API キーのロールを変更すると、指定した値が API キーに割り当てられた既存のロールを上書きします。

apiKeyId 引数の可能な値を表示するには、 Atlas組織 apiKeys list を実行します。

このコマンドを使用するには、ユーザーアカウントまたは組織ユーザー管理者ロールの API キーで認証する必要があります。

構文

コマンド構文

atlas organizations apiKeys assign <apiKeyId> [options]

Arguments

名前	タイプ	必須	説明
apiKeyId	string	true	キーを識別する一意な 24stringAPI 桁の。

オプション

名前	タイプ	必須	説明
--desc	string	false	API キーの説明。
-h, --help		false	割り当てられるヘルプ
--orgId	string	false	使用する組織ID。このオプションは、構成ファイルまたは環境変数の設定を上書きします。
-o, --output	string	false	出力形式。有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。完全な出力を表示するには、 -o JSONオプションを使用します。
--role	string	false	API キーに割り当てたいロール。複数のロールを割り当てるには、個別のロールフラグで各ロールを指定するか、1 つのロールフラグを使用してすべてのロールをカンマ区切りのリストとして指定します。 CLI が受け入れる値については、Atlas API 仕様のロールのアイテム列挙型を参照してください。 https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v 2 / # tags/プログラマティック API キー/operation/createApiKey/ 。このフラグを渡すと、既存のデータが置き換えられます。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

出力

コマンドが成功すると、CLI は次のサンプルのような出力を返します。括弧内の値は値を表します。

API Key '<Id>' successfully updated.

例

# Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json

戻る

list

create