重要
それぞれの Atlas Administration API には独自のリソースがあり、初期設定が必要です。
Atlas Administration API サーバーには、パブリックインターネットからのみアクセスできます。Atlas Administration API は、ネットワーク ピアリングまたはプライベート エンドポイントを使用する接続では使用できません。
詳細については、 「プログラムによる Atlas へのアクセス」を参照してください。
Atlas 管理API は、REST アーキテクチャ スタイルの原則に従い、Atlas の機能へのプログラムによるアクセスを可能にする多数の内部リソースを公開します。Atlas Administration APIの詳細については、Atlas Administration APIリファレンスを参照してください。
The Atlas Administration API doesn't provide access to the data stored in your clusters. To read or write data in a database, you must authenticate to your cluster using the credentials for a database user with the appropriate read or write roles. You can use the Atlas Administration API to create and manage database users.
Atlas 管理APIを使用して Atlas クラスターを管理するには、次のいずれかの認証方法でAPIリクエストを認証する必要があります。
サービス アカウント アクセス トークン（OAuth 2.0）
APIキー（HTTPダイジェスト認証）
これらの方法の詳細については、Atlas Administration API認証メソッドを参照してください。
次のセクションでは、サービス アカウントとAPIキーを使用して、Atlas 組織とプロジェクトへのプログラムによるアクセスを構成する方法について説明します。
注意
The MongoDB Atlas Shared Responsibility Model defines the complementary duties of MongoDB and its customers in maintaining a secure and resilient data environment. Under this framework, MongoDB manages the security and operational integrity of the underlying platform, while customers are responsible for the configuration, management, and data policies of their specific deployments. For a detailed breakdown of ownership across security and operational excellence, see Shared Responsibility Model.
始める前に
プログラムによるアクセスを構成する前に、次の点を確認してください。
Atlas アカウントを持っています。作成するには、「Atlas アカウントの作成」を参照してください。
Atlas 組織が存在します。作成するには、組織の作成を参照してください。
必要なアクセス権
組織のサービス アカウントまたは API キーを作成するには、その組織に対して Organization Owner アクセスが必要です。
プロジェクトへのサービス アカウントへのアクセスを許可するには、プロジェクト を所有する組織への Organization Owner アクセス権が必要です。
API キーにプロジェクトへのアクセス権を付与するには、そのプロジェクトに対するProject Owner アクセス権が必要です。
任意: IPアクセス リストが必要
Atlas UI を使用して組織を作成するとき、Atlas は Atlas Administration API のために IP アクセス リストを必要とします。これにより、API リクエストは、IP アクセス リストで指定したロケーションベースの IP または CIDR アドレスからのものに限定されます。Atlas Administration API に IP アクセス リスト エントリなしでリクエストを行うと、サーバーは 403 ステータスコードで応答します。
この機能を無効にすると、IP アクセス リストが空である限り、インターネット上の任意のアドレスから API リクエストを行うことができます。IP アクセス リスト エントリを追加すると、その IP アドレスからのリクエストのみがリクエストを実行できます。
注意
IP アクセス リストは、サービス アカウント アクセス トークンの使用に適用され、作成または取り消しではありません。任意のIPアドレスからトークンを生成できますが、そのIPアドレスがアクセスリストにある場合のみ、APIを呼び出すことができます。
注意
IP アクセス リストは、プログラムによる API キーとサービス アカウンントにのみ適用されます。これらは、Atlas CLI などの Atlas Administration API へのその他のアクセス、または Atlas App Connections を介して付与される委任アクセスには適用されません。委任されたアクセスには、サードパーティの提携アプリケーション、MongoDB Compass などの MongoDB アプリケーション、および Model Context Protocol (MCP) クライアントが含まれます。組織で Atlas Administration API のすべてのトラフィックが特定のアドレスから発信される必要がある場合は、その組織ではアプリのアクセス委任を有効にしないでください。提携するアプリケーションと MCP クライアント向けの委任アクセス設定は、既存の組織ではデフォルトではオフになっています。
組織の作成後、すべての Atlas Administration API リクエストに対して IP アクセス リストを要求するように組織を設定するには、次の手順を実行します。
Atlas で、Organization Settings ページに移動します。
まだ表示されていない場合は、以下から目的の組織を選択しますナビゲーション バーのOrganizationsメニュー
サイドバーで、Organization Settings をクリックします。
[ Organization Settings ]ページが表示されます。
組織へのプログラムによるアクセスの付与
プロジェクトへのプログラムによるアクセスの付与
これら 2 つの認証方法の詳細については、Atlas 管理API認証メソッド を参照してください。
API キーにプロジェクトへのアクセス権を付与するには、そのプロジェクトに対する Project Access Manager または Project Owner アクセス権が必要です。
プロジェクトからのプロジェクト アクセス権の追加
組織用のサービス アカウントまたは API キーをまだ作成していない場合は、プロジェクト用に作成して、そのプロジェクトに Atlas Administration API へのアクセス権を付与できます。プロジェクトに対して作成したサービス アカウントまたは API キーは、権限 Organization Member を持つ親組織に自動的に追加されます。
APIリクエストを行う
Atlas Administration API は、サービス アカウントまたは API キーという 2 つの認証方法のいずれかを使用してリクエストを認証します。次の手順を完了するには、希望する認証方法を構成するときに保存したキーまたはシークレットが必要です。
すべての Atlas Administration API エンドポイントには次のベース URL があります。
https://cloud.mongodb.com/api/atlas/<version>
重要
MongoDB は、セキュリティを強化するために HTTPS URL を使用します。HTTP URL を使用すると、301ステータスコードが返されます。
あるいは、 OpenAPI v3 仕様をサポートする任意のツールを使用して、コードサンプルやモック サーバーを生成することもできます。例、Atlas Admin API仕様 を Postman にインポートしてcurl コマンドを生成できます。
警告
Postman を使用して HTTP URL を使用すると、期待どおりに301ステータスコードが返されます。しかし、このシナリオでは、Postman が HTTPS でリクエストを自動的に再試行する可能性がありますが、同時に再試行リクエストからヘッダーと本文を削除することがあります。これにより、301ではなく401のステータスコードが返され、リクエストが失敗した理由を特定することが困難になります。
以下の方法で、Postman を使用して curl コマンドを生成します。
In the MongoDB Atlas Administration API documentation, click Download source in the navigation bar.
次のステップ
Atlas Administration API の詳細については、「Atlas Administration API リファレンス」を参照してください。
プログラムによる Atlas Administration API へのアクセスを管理するには、次のいずれかの手順を参照してください。