注意：项目 ID 和群组 ID 这两个术语可以互换。

Atlas App Services Admin API 端点经常要求您在 URL 中包含两个参数：

• 您的 Atlas 项目 ID（有时也称为群组 ID）
• 您的 App Services 应用程序 ID

项目 ID

您可以从 MongoDB Atlas 仪表盘或使用 MongoDB Atlas CLI 查找项目 ID。

应用程序 ID

要查找应用程序 ID，请向项目的列出应用程序端点发出请求。您需要一个 access_token 来发出此请求。要了解如何获取令牌，请参阅获取管理员 API 会话访问令牌。

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

该操作将返回描述所提供项目/群组中每个 App Services 应用程序的对象列表。对于 Admin API 请求，应用程序 ID 是 _id 字段中的对象标识符值，而不是 client_app_id。

[
  {
    "_id": "5997529e46224c6e42gb6dd9",
    "group_id": "57879f6cc4b32dbe440bb8c5",
    "domain_id": "5886619e46124e4c42fb5dd8",
    "client_app_id": "myapp-abcde",
    "name": "myapp",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "last_used": 1615153544,
    "last_modified": 0,
    "product": "standard",
    "environment": ""
  }
]

对 App Services Admin API 的每个请求都必须包含由 MongoDB Cloud API 签发的未过期的有效访问令牌。您将此令牌包含在使用承载身份验证方案的每个请求的 Authorization 头中。

您需要有效的 MongoDB Atlas 编程 API 密钥才能让 MongoDB Atlas 获取令牌。

获得 API 密钥对后，调用身份验证端点：

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login

如果身份验证成功，App Services 将返回一个访问令牌作为 JSON 响应文档的一部分：

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

access_token 表示与管理员 API 交互的限时授权。要对请求进行身份验证，请将该令牌包含在持有者令牌 Authorization 标头中。

Authorization: Bearer <access_token>

会话访问令牌会在其颁发 30 分钟后过期。当您登录时，响应还包含一个 refresh_token，您可以使用它来获取新的访问令牌。这非常有用，因为您只需使用凭证登录一次。之后，只要刷新令牌有效，您就可以使用刷新令牌重新进行身份验证。

默认情况下，刷新令牌在发放 60 天后失效。您可以自定义刷新令牌的有效期，最短 30 分钟，最长 5 年。

要刷新身份验证并获取新的 access_token，请使用 Authorization 标头中的 refresh_token 调用身份验证会话端点：

curl --request POST \
  --header 'Authorization: Bearer <refresh_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/session

如果刷新令牌有效，响应正文将包含一个新 access_token，该令牌在接下来的 30 分钟内有效：

{
  "access_token": "<access_token>"
}

登录并管理 App Services 应用程序。

通过 API 密钥提供商查看和管理 API 密钥。

查看和管理 Atlas 项目中的应用程序。

查看和管理身份验证提供者。