注: 「プロジェクトID」と「グループID」という用語は同じ意味で使用されます。

Atlas App Services Admin API エンドポイントでは、URL に次の 2 つのパラメータを含めることが頻繁に必要になります。

• Atlas のプロジェクトID（別名、グループID）
• App Services アプリケーションID

プロジェクトID

プロジェクト ID は、MongoDB Atlas ダッシュボードまたは MongoDB Atlas CLI から見つけることができます。

アプリケーションID

アプリケーションID を見つけるには、プロジェクトの List Apps エンドポイントにリクエストを送信します。このリクエストを行うには 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 アプリを記述するオブジェクトのリストが返されます。管理 API リクエストの場合、アプリケーション ID は client_app_id ではなく、_id フィールドの ObjectId 値です。

[
  {
    "_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 によって発行された有効で期限切れでないアクセス トークンが含まれている必要があります。Bearer 認証スキームを使用して、各リクエストの Authorization ヘッダーにこのトークンを含めます。

MongoDB Atlas がトークンを取得するには、有効な MongoDB Atlas プログラム API キー が必要です。

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 は、Admin API と対話するための期間限定の承認を表します。リクエストを認証するには、Bearer トークン 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

更新トークンが有効な場合、レスポンス本文には今後 30 分間有効な新しい access_token が含まれます。

{
  "access_token": "<access_token>"
}

ログインして App Services アプリを管理します。

API キー プロバイダー を通じて API キーを表示および管理します。

Atlas プロジェクト内のアプリケーションを表示および管理します。

認証プロバイダを表示および管理します。