开始委托 OAuth 授权

获取 /api/v1/oauth/{资源}/initiate
持有者身份验证

为经过身份验证的用户保留待处理的授权，并返回用户界面应将浏览器导航到的URL ，以便访问资源授权服务器。

路径参数

  • resource 字符串 必需

    配置的资源名称（例如 atlas）

查询参数

  • 来年 字符串

    回调后将用户重定向到此网关上的路径（必须以 / 开头）

响应

  • 406

    不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式（包括不支持的媒体类型参数或排除的 SSE）。现有的身份验证、授权和速率限制失败优先。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息； API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称；不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。
  • 200

    正常

    隐藏响应属性 显示响应属性 对象
    • authorize_url 字符串
    隐藏响应属性 显示响应属性 对象
    • authorize_url 字符串
  • 401

    Unauthorized

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 404

    资源未注册

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 500

    内部服务器错误

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 503

    未配置平台 OAuth

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
GET /api/v1/oauth/{资源}/initiate 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/oauth/{resource}/initiate' \
 --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) 
{
  "authorize_url": "string"
}
响应示例 (200) 
{
  "authorize_url": "string"
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (401) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (404) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}
响应示例 (503) 
{
  "code": "string",
  "error": "string",
  "success": true
}