Lista de organizaciones

OBTENER /api/v1/organizaciones
Autorización del portador

Devuelve únicamente las organizaciones a las que pertenece el solicitante. Si la concesión de Atlas no se puede utilizar, las últimas organizaciones reflejadas se siguen devolviendo en modo de solo lectura con atlas_reauth_required=true.

Respuestas

  • 406

    Versión de API no compatible o con formato incorrecto, operación no disponible en el contrato publicado seleccionado o representación inaceptable (incluidos parámetros de tipo de medio no compatibles o SSE excluidos). Los fallos de autenticación, autorización y límite de velocidad existentes tienen prioridad.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalles de validación opcionales definidos por el esquema de error estándar; los errores de negociación de la API no emiten este campo.

      Ocultad el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • Campos arreglo[objeto]

        Campos con errores de validación.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto

        Un campo y su fallo de validación.

        • Descripción string Requerido

          Fallo en la validación legible para humanos.

        • Campo string Requerido

          Nombre o ruta del campo de solicitud no válido.

    • detalle string Requerido

      Detalles de errores legibles para humanos.

    • Error entero Requerido

      HTTP status code.

    • errorCode string Requerido

      Código de error legible por máquina.

    • Parámetros array[string]

      Nombres de los parámetros de la solicitud asociados con el error; se omiten cuando no corresponde ninguno.

    • motivo string Requerido

      Frase que indica el motivo del estado HTTP.
  • 200

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • atlas_reauth_required booleano

      AtlasReauthRequired se establece en esta respuesta 200 cuando la concesión de Atlas no se puede utilizar, pero la puerta de enlace aún devuelve las últimas organizaciones reflejadas como de solo lectura. Los clientes deben iniciar la recuperación desde este campo; la lista de organizaciones no devuelve 401 PLATFORM_OAUTH_*.

    • limit entero

      Limit y Offset reflejan la paginación aplicada. Se configuran únicamente en la lista de administración de la plataforma paginada; se omiten en los puntos de acceso de la organización a los miembros.

    • desplazamiento entero
    • Organizaciones arreglo[objeto]
      Ocultar atributos de las organizaciones Mostrar atributos de las organizaciones Objeto
      • administradores arreglo[objeto]

        La lista de administradores muestra los ORG_ADMINS de la organización. Solo se muestra en la lista de administradores de la plataforma; se omite en los puntos de acceso de la organización a los miembros.

        Ocultar atributos de administrador Mostrar atributos de administrador Objeto
        • correo electrónico string
        • Nombre string
      • atlas Objeto
        Ocultar atributos del atlas Mostrar atributos del atlas Objeto
        • entorno string Requerido
        • ID string Requerido
      • created_at string
      • Descripción string
      • ID string
      • Nombre string
      • Origen string

        Los valores son atlas o agent_engine.

      • updated_at string
    • Total entero
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • atlas_reauth_required booleano

      AtlasReauthRequired se establece en esta respuesta 200 cuando la concesión de Atlas no se puede utilizar, pero la puerta de enlace aún devuelve las últimas organizaciones reflejadas como de solo lectura. Los clientes deben iniciar la recuperación desde este campo; la lista de organizaciones no devuelve 401 PLATFORM_OAUTH_*.

    • limit entero

      Limit y Offset reflejan la paginación aplicada. Se configuran únicamente en la lista de administración de la plataforma paginada; se omiten en los puntos de acceso de la organización a los miembros.

    • desplazamiento entero
    • Organizaciones arreglo[objeto]
      Ocultar atributos de las organizaciones Mostrar atributos de las organizaciones Objeto
      • administradores arreglo[objeto]

        La lista de administradores muestra los ORG_ADMINS de la organización. Solo se muestra en la lista de administradores de la plataforma; se omite en los puntos de acceso de la organización a los miembros.

        Ocultar atributos de administrador Mostrar atributos de administrador Objeto
        • correo electrónico string
        • Nombre string
      • atlas Objeto
        Ocultar atributos del atlas Mostrar atributos del atlas Objeto
        • entorno string Requerido
        • ID string Requerido
      • created_at string
      • Descripción string
      • ID string
      • Nombre string
      • Origen string

        Los valores son atlas o agent_engine.

      • updated_at string
    • Total entero
  • 500

    Error interno del servidor

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Código string
    • Error string
    • éxito booleano
OBTENER /api/v1/organizaciones 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/organizations' \
 --header "Authorization: $API_KEY"
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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"
}
Ejemplos de respuesta (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
}
Ejemplos de respuesta (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
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}