Atlas組織 apiKeys create
組織の API キーを作成します。
MongoDB はプライベート API キーを 1 回だけ返します。 このコマンドを実行した後、公開 API キーとプライベート API キーの両方をすぐにコピー、保存、安全にします。
このコマンドを使用するには、ユーザー アカウントまたは組織ユーザー管理者ロールの API キーで認証する必要があります。
構文
コマンド構文
atlas organizations apiKeys create [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--desc | string | true | API キーの説明。 |
-h, --help | false | 作成用ヘルプ | |
--orgId | string | false | 使用する組織ID。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--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/createApiKey/ |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-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 organization owner access in the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json