Atlasは APIKeys の割り当てをプロジェクトします

項目一覧

構文

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

指定された組織 API キーをプロジェクトに割り当て、プロジェクトの API キーのロールを変更します。

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

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

構文

コマンド構文

atlas projects apiKeys assign <ID> [options]

Arguments

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

オプション

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

継承されたオプション

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

出力

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

API Key successfully assigned.

例

# Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json

戻る

API キー

create