얻다 /api/v1/organizations

호출자가 멤버십을 가지고 있는 조직만 반환합니다. Atlas 권한 부여를 사용할 수 없는 경우, 마지막으로 반영된 조직은 여전히 atlas_reauth_required=true로 읽기 전용으로 반환됩니다.

응답

  • 지원되지 않거나 잘못된 API 버전, 선택한 게시된 계약에서 사용할 수 없는 작업 또는 허용되지 않는 표현(지원되지 않는 미디어 유형 매개변수 또는 제외된 SSE 포함). 기존 인증, 권한 부여 및 속도 제한 실패가 우선적으로 적용됩니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      표준 오류 스키마 에 정의된 선택적 유효성 검사 세부 정보입니다. API 협상 오류는 이 필드 내보내지 않습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        유효성 검사 에 실패한 필드입니다.

        필드 속성 숨기기 필드 속성 표시 객체

        필드 및 해당 유효성 검사 실패.

        • description 문자열 필수 사항

          사람이 읽을 수 있는 유효성 검사 실패.

        • 필드 문자열 필수 사항

          잘못된 요청 필드 의 이름 또는 경로입니다.

    • 세부 정보 문자열 필수 사항

      사람이 읽을 수 있는 오류 세부 정보.

    • 오류 integer 필수 사항

      HTTP status code.

    • 오류 코드 문자열 필수 사항

      기계가 읽을 수 있는 오류 코드입니다.

    • 매개변수 array[string]

      오류와 관련된 요청 매개변수 이름입니다. 적용 않는 경우 생략됩니다.

    • 이유 문자열 필수 사항

      HTTP 상태 이유 구문입니다.

  • 200

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • atlas_reauth_required 부울

      Atlas 권한 부여를 사용할 수 없지만 게이트웨이가 여전히 마지막으로 반영된 조직을 읽기 전용으로 반환하는 경우 이 200 응답에 AtlasReauthRequired가 설정하다 됩니다. 클라이언트는 이 필드 에서 복구를 시작해야 합니다. 조직 목록이 401 PLATFORM_OAUTH_*를 반환하지 않습니다.

    • limit integer

      Limit 및 Offset은 적용된 페이지 매김을 반영합니다. 페이지가 매겨진 플랫폼 관리자 목록에 의해서만 설정됩니다. 멤버 대면 조직 엔드포인트에서는 생략되었습니다.

    • 오프셋 integer
    • 조직 배열[객체]
      조직 속성 숨기기 조직 속성 표시 객체
      • 관리자 배열[객체]

        관리자는 조직의 ORG_ADMIN을 나열합니다. 플랫폼 관리자 목록으로만 채워집니다. 멤버 대면 조직 엔드포인트에서는 생략되었습니다.

        관리자 속성 숨기기 관리자 속성 표시 객체
        • 이메일 문자열
        • 이름 문자열
      • Atlas 객체
        Atlas 속성 숨기기 Atlas 속성 표시 객체
        • 환경 문자열 필수 사항
        • id 문자열 필수 사항
      • created_at 문자열
      • description 문자열
      • id 문자열
      • 이름 문자열
      • source 문자열

        값은 atlas 또는 agent_engine입니다.

      • updated_at 문자열
    • 합계 integer
    응답 속성 숨기기 응답 속성 표시 객체
    • atlas_reauth_required 부울

      Atlas 권한 부여를 사용할 수 없지만 게이트웨이가 여전히 마지막으로 반영된 조직을 읽기 전용으로 반환하는 경우 이 200 응답에 AtlasReauthRequired가 설정하다 됩니다. 클라이언트는 이 필드 에서 복구를 시작해야 합니다. 조직 목록이 401 PLATFORM_OAUTH_*를 반환하지 않습니다.

    • limit integer

      Limit 및 Offset은 적용된 페이지 매김을 반영합니다. 페이지가 매겨진 플랫폼 관리자 목록에 의해서만 설정됩니다. 멤버 대면 조직 엔드포인트에서는 생략되었습니다.

    • 오프셋 integer
    • 조직 배열[객체]
      조직 속성 숨기기 조직 속성 표시 객체
      • 관리자 배열[객체]

        관리자는 조직의 ORG_ADMIN을 나열합니다. 플랫폼 관리자 목록으로만 채워집니다. 멤버 대면 조직 엔드포인트에서는 생략되었습니다.

        관리자 속성 숨기기 관리자 속성 표시 객체
        • 이메일 문자열
        • 이름 문자열
      • Atlas 객체
        Atlas 속성 숨기기 Atlas 속성 표시 객체
        • 환경 문자열 필수 사항
        • id 문자열 필수 사항
      • created_at 문자열
      • description 문자열
      • id 문자열
      • 이름 문자열
      • source 문자열

        값은 atlas 또는 agent_engine입니다.

      • updated_at 문자열
    • 합계 integer
  • 내부 서버 오류

    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
    응답 속성 숨기기 응답 속성 표시 객체
    • 코드 문자열
    • 오류 문자열
    • Success 부울
GET /api/v1/organizations
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/organizations' \
 --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)
{
  "atlas_reauth_required": true,
  "limit": 42,
  "offset": 42,
  "organizations": [
    {
      "admins": [
        {
          "email": "string",
          "name": "string"
        }
      ],
      "atlas": {
        "environment": "string",
        "id": "string"
      },
      "created_at": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "source": "atlas",
      "updated_at": "string"
    }
  ],
  "total": 42
}
응답 예시(200)
{
  "atlas_reauth_required": true,
  "limit": 42,
  "offset": 42,
  "organizations": [
    {
      "admins": [
        {
          "email": "string",
          "name": "string"
        }
      ],
      "atlas": {
        "environment": "string",
        "id": "string"
      },
      "created_at": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "source": "atlas",
      "updated_at": "string"
    }
  ],
  "total": 42
}
응답 예시(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
응답 예시(500)
{
  "code": "string",
  "error": "string",
  "success": true
}