Atlas projects apiKeys create

項目一覧

構文

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

組織 API キーを作成し、それをプロジェクトに割り当てます。

MongoDB はプライベートAPIキーを1 回だけ返します。このコマンドを実行した後、公開 API キーとプライベートAPIキーの両方をすぐにコピー、保存、安全にします。組織レベルのロールを指定しない場合、 APIキーはデフォルトでプロジェクトの親組織の組織メンバーになります。

このコマンドを使用するには、ユーザーアカウントまたは次のいずれかのロールを持つAPIキーで認証する必要があります。組織レベルのロールを管理するには、プロジェクトユーザー管理者または組織ユーザー管理者を選択します。

構文

コマンド構文

atlas projects apiKeys create [options]

オプション

名前	タイプ	必須	説明
--desc	string	true	API キーの説明。
-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 つのロールフラグを使用してすべてのロールをカンマ区切りのリストとして指定します。受け入れ値の完全なリストについては、対応する Atlas APIエンドポイントのアイテム列挙型を参照してください。https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/#tags/Programmatic-API-Keys/操作/createProjectApiKey.プロジェクトレベルのユーザーロールの詳細については、https://docub.mongodb.org/core/atlas-proj-roles を参照してください。

継承されたオプション

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

出力

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

API Key '<Id>' created.
Public API Key <PublicKey>
Private API Key <PrivateKey>

例

# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json

# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json

戻る

割り当て

削除