Docs Menu

mongocli IAM プロジェクト apiKeys assign

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

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

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

コマンド構文
mongocli iam projects apiKeys assign <ID> [options]
名前
タイプ
必須
説明

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/v3 2 /# tags/プログラマティック API-キー/operation/createProjectApiKey/.

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。 MongoCLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-configuration-file を参照してください。

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