認証されたプリンシパルの Atlas 組織を一覧表示する

GET /api/v1/atlas/orgs

Atlas Admin API GET /orgs をプロキシします。人間とAPIキーは、呼び出し元の委任された OAuth トークンを使用します。アクティブな Atlas ペアを持つエージェント エンジンの ORM/PROJECT サービス アカウントは、そのサービス アカウントの独自の認証情報を使用します。

応答

  • サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現(サポートされていないメディアタイプのパラメーター、または除外された SSE を含む)。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

  • 200

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 結果 array[オブジェクト]
      結果属性を非表示にする 結果属性の表示 オブジェクト
      • id string
      • is_deleted ブール値
      • name string
    • total_count integer
    応答属性の非表示 応答属性の表示 オブジェクト
    • 結果 array[オブジェクト]
      結果属性を非表示にする 結果属性の表示 オブジェクト
      • id string
      • is_deleted ブール値
      • name string
    • total_count integer
  • 401

    PLATFOR :しないでください

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 403

    Atlas_SERVICE_ACCOUUNT_NOT_PA別LED_マシンプリンシパルにアクティブなペアがありません。禁止 — ネットワークまたはマシン機能のフラグ オフ

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 500

    InterNAL_ERROR — ペアリング検索が失敗

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 502

    Atlas_SERVICE_ACCOUNT_CREDNIAL_UNAVAILABLE または Atlas が到達不能 / 非 OK 応答

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 503

    PLATCOM: SERVICE_UNAVAILABLE — 委任トークン更新はすでに進行中

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
GET /api/v1/atlas/orgs
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/atlas/orgs' \
 --header "Authorization: $API_KEY"
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(200)
{
  "results": [
    {
      "id": "string",
      "is_deleted": true,
      "name": "string"
    }
  ],
  "total_count": 42
}
応答の例(200)
{
  "results": [
    {
      "id": "string",
      "is_deleted": true,
      "name": "string"
    }
  ],
  "total_count": 42
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(403)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(403)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
{
  "code": "string",
  "error": "string",
  "success": true
}