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 管理 API 身份验证方法。

以下部分介绍如何使用服务帐户和API密钥来配置对Atlas组织和项目的编程访问权限。

注意

开始之前

在配置程序访问之前，请确认以下内容：

您已有 Atlas 账户。要创建一个，请参阅创建 Atlas 账户。
存在 Atlas 组织。要创建一个，请参阅创建组织。

必需的访问权限

要为组织创建服务账户或 API 密钥，您必须具有该组织的 Organization Owner 访问权限。

要授予服务帐户对项目的访问权限，您必须对拥有该项目的组织具有Organization Owner访问权限。

要让 API 密钥访问项目，您必须拥有该项目的 Project Owner 访问权限。

可选：需要IP访问列表

使用 Atlas 用户界面创建组织时，Atlas 需要 Atlas Administration API 的 IP 访问列表。这将 API 请求限制为仅来自您在 IP 访问列表中指定的基于位置的 IP 或 CIDR 地址的请求。如果您在没有 IP 访问列表条目的情况下向 Atlas Administration API 发出请求，服务器则会返回 403 状态码。

如果您禁用此功能，只要 IP 访问列表为空，您就可以从互联网上的任何地址发出 API 请求。一旦您添加了 IP访问列表条目，则只有来自该 IP 地址的请求才会发出请求。

注意

IP访问列表应用于使用服务帐户访问令牌，而不是创建或撤销它们。您可以从任何IP生成令牌，但只有当您的IP位于访问权限列表上时，才能使用它来调用API。

注意

IP访问列表仅应用于程序化 API 密钥和服务账户。他们不适用于对 Atlas Administration API 的其他类型访问，例如 Atlas CLI 或通过 Atlas 应用连接授予的授权访问。委托访问包括第三方合作伙伴应用程序、MongoDB 应用程序（如 MongoDB Compass）和模型上下文协议 (MCP) 客户端。如果您的组织要求所有 Atlas Administration API 流量源自特定地址，请勿针对该组织启用委托应用访问。现有组织中，合作伙伴应用程序和 MCP 客户端的委托访问设置默认为关闭状态。

要将您的组织设置为在创建组织后要求为每个 Atlas Administration API 请求提供 IP 访问列表，请执行以下步骤：

在 Atlas 中，转到 Organization Settings（项目设置）页面。

如果尚未显示，组织从导航栏中的Organizations菜单。
在侧边栏中，单击 Organization Settings。

显示“组织设置”页面。

将 Require IP Access List for the Atlas Administration API 设置切换为 On。

为组织授予编程访问权限

授予对项目的编程访问权限

要学习了解有关这两种身份验证方法的更多信息，请参阅Atlas 管理 API身份验证方法。

要让 API 密钥访问某个项目，您必须拥有该项目的 Project Access Manager 或 Project Owner 访问权限。

从项目添加项目访问权限

如果您尚未为组织创建服务账户或 API 密钥，则可以为项目创建它们，以授予该项目访问 Atlas Administration API 的权限。为项目创建的服务帐户或 API 密钥会自动添加到父组织中，权限为 Organization Member。

发出API请求

Atlas 管理 API 使用以下两种身份验证方法之一来验证请求：服务帐户或 API 密钥。您需要在配置首选身份验证方法时保存的密钥或机密来完成以下步骤。

所有 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 重试请求，但同时会从重试请求中删除标头和正文。这将返回 401 状态码而不是 301，这使得很难确定请求失败的原因。

要使用 Postman 生成 curl 命令：

In the MongoDB Atlas Administration API documentation, click Download source in the navigation bar.

右键单击要下载的OpenAPI 规范格式，然后复制链接。

打开 Postman 并单击 File，然后单击 Import。

显示 Import窗口。

在 Import 窗口中，单击 Link 并粘贴您在步骤 2 中复制的下载链接。

单击 Continue，然后单击 Import。

对于要为其生成 `curl` 命令的请求，请单击右侧的 </> 并从 Code snippet 下拉列表中选择 cURL。

后续步骤

要了解有关 Atlas Administration API 的更多信息，请参阅 Atlas Administration API 参考资料。

要管理对 Atlas Administration API 的编程访问，请参阅以下任一过程：

开始使用 Atlas Administration API