atlas api ProgrammaticApiKeys getOrgApiKey

1 つの組織の API キーを返します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリースライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメントリンクから確認できます。

組織 API キーは、組織へのプログラムによるアクセスを許可します。API キーを使用して、ユーザーインターフェイスから MongoDB Cloud にログインすることはできません。このリソースを使用するには、リクエストするサービスアカウントまたは API キーに Organization Member のロールが必要です。

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getorgapikey.

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文

atlas api programmaticApiKeys getOrgApiKey [options]

オプション

名前	タイプ	必須	説明
--apiUserId	string	true	更新したい組織 API を識別する、ユニークな 24 桁の 16 進数の文字列。
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
-h, --help		false	getOrgApiKey のヘルプ
--orgId	/orgs	true	プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列。 [/orgs](#Tag/Organizations/ 操作/listOrganizations) エンドポイントを使用して、認証されたユーザーがアクセスできるすべての組織を取得します。
-o, --output	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- outputFile	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
--version	string	false	API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値をプロファイルします。この値のデフォルトは "2023-01-01"

継承されたオプション

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

例

atlas api programmaticApiKeys getOrgApiKey --version 2023-01-01 --apiUserId [apiUserId] --orgId 4888442a3354817a7320eb61

戻る

getOrgAccessEntry

listGroupApiKeys