MongoDB Cloud API を使用するためのアクセストークンの返却、追加、編集、削除を行います。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
MongoDB Cloud はこれらのキーを組織に適用します。これらのリソースによって、指定されたプロジェクト内でキーを返却したり、割り当てたり、取り消したりすることができます。
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | プログラマティックApiKeys のヘルプ |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
関連コマンド
atlas api ProgrammaticApiKeys addGroupApiKey - 指定された組織APIキーを指定されたプロジェクトに割り当てます。
atlas api ProgrammaticApiKeys createGroupApiKey - 指定された組織APIキーを作成し、指定されたプロジェクトに割り当てます。
atlas api ProgrammaticApiKeys createOrgAccessEntry - 指定された組織APIキーのアクセス リスト エントリを作成します。
atlas api ProgrammaticApiKeys createOrgApiKey - 指定された組織に対して 1 つのAPIキーを作成します。
atlas api ProgrammaticApiKeys deleteAccessEntry - 指定された組織APIキーから指定されたアクセス リスト エントリを削除します。
atlas api ProgrammaticApiKeys deleteOrgApiKey - 指定された組織から 1 つの組織APIキーを削除します。
atlas api ProgrammaticApiKeys getOrgAccessEntry - 指定された組織APIキーのアクセス リスト エントリを 1 つ返します。
atlas api ProgrammaticApiKeys getOrgApiKey - 1 つの組織のAPIキーを返します。
atlas api ProgrammaticApiKeys listGroupApiKeys - 指定したプロジェクトに割り当てたすべての組織APIキーを返します。
atlas api ProgrammaticApiKeys listOrgAccessEntries - 指定した組織のAPIキーに設定したすべてのアクセスリストエントリを返します。
atlas api ProgrammaticApiKeys listOrgApiKeys - 指定された組織のすべての組織APIキーを返します。
atlas api ProgrammaticApiKeys deleteGroupApiKey - 指定されたプロジェクトから 1 つの組織APIキーを削除します。
atlas api ProgrammaticApiKeys updateApiKeyRoles - 指定したプロジェクトに対して指定した組織APIキーのロールを更新します。
atlas api ProgrammaticApiKeys updateOrgApiKey - 指定された組織の 1 つの組織APIキーを更新します。