Iniciar una concesión OAuth delegada

OBTENER /api/v1/oauth/{resource}/initiate
Autorización del portador

Mantiene una concesión pendiente para el usuario autenticado y devuelve la URL a la que la interfaz de usuario debe dirigir el navegador para acceder al servidor de autorización de recursos.

Parámetros de path

  • resource string Requerido

    Nombre del recurso configurado (por ejemplo, atlas)

Parámetros de query

  • Next string

    Ruta en esta puerta de enlace a la que se redirigirá al usuario después de la devolución de llamada (debe comenzar con /).

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 atributo de respuesta Mostrar atributo de respuesta Objeto
    • URL de autorización string
    Ocultar atributo de respuesta Mostrar atributo de respuesta Objeto
    • URL de autorización string
  • 401

    No autorizado

    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
  • 404

    Recurso no registrado

    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
  • 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
  • 503

    Plataforma OAuth no configurada

    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
GET /api/v1/oauth/{resource}/initiate 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/oauth/{resource}/initiate' \
 --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) 
{
  "authorize_url": "string"
}
Ejemplos de respuesta (200) 
{
  "authorize_url": "string"
}
Ejemplos de respuesta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Ejemplos de respuesta (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}