# 发起插件账号授权

```{raw} html
<div class="mo-api-page-show-toc" aria-hidden="true"></div>
```

为插件账号返回浏览器交接或授权操作。

```text
POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/plugin-connections/{connection_id}/oauth
```

## 调用前准备

准备目标工作区 ID 和可访问相应资源、具有当前动作权限的个人访问令牌。路径中 `workspace_id`、`connection_id` 使用相应资源的实际标识。工作区 ID 同时填入 `X-Workspace-ID`。示例使用 `jq` 构造 JSON，运行前安装。环境变量的来源见[公共对象与输入](objects.md#输入标识)。

## 请求体

:::::::{div} mo-api-tabs
::::::{tab-set}
:::::{tab-item} 输入示例

```bash
curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/plugin-connections/$CONNECTION_ID/oauth" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  --data-binary "$(jq -n --argjson CONNECTION_VERSION "$CONNECTION_VERSION" '
{
  "expected_version": $CONNECTION_VERSION,
  "initiator": "external"
}
')"
```

:::::
:::::{tab-item} 参数说明

按 grant 分支处理响应。external 发起授权码配置时返回 browser_handoff，尝试 ID 为空；打开产品浏览器页面后回读状态。不要从外部客户端伪装 browser 来绕过浏览器证明。设备授权和托管会话按返回的非空 attempt_id 与 poll_after 继续。

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `expected_version` | integer | 是 | 当前连接或安装的 version，必须大于 0。 |
| `initiator` | string | 条件必填 | 授权码配置使用 external 或 browser；外部 SDK/CLI 选择 external。 |
| `expected_actor_id` | string | 否 | 浏览器交接时校验当前账号；提供时须与调用者一致。 |
| `runtime_context_id` | string | 否 | 需要关联已有交互时提供实际上下文 ID，不自行构造。 |

JSON 对象不接受未知字段、重复键或多个连续对象；总请求体不超过 1 MiB。

:::::
::::::
:::::::

## 成功响应

:::::::{div} mo-api-tabs mo-api-response-tabs
::::::{tab-set}
:::::{tab-item} 响应示例

```json
{
  "code": 0,
  "data": {
    "attempt_id": "",
    "grant": "browser_handoff",
    "authorization_url": "https://console.example.invalid/authorization",
    "expires_at": "2026-11-11T00:10:00Z"
  }
}
```

:::::
:::::{tab-item} 字段说明

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 0。 |
| `data` | object | 当前动作返回的数据。 |
| `data.attempt_id` | string | 授权尝试 ID；browser_handoff 为空。 |
| `data.grant` | string | 资源字段，详见[公共对象与状态](objects.md)。 |
| `data.authorization_url` | string | 按 grant 打开对应用户授权页面。 |
| `data.expires_at` | string | 资源字段，详见[公共对象与状态](objects.md)。 |

:::::
::::::
:::::::

## 错误响应

业务错误的数字 `code`、`message` 和 `details.reason` 以及授权层错误的字符串代码分别处理，见[错误与状态](objects.md#错误响应)。遇到状态或版本冲突时先读取当前资源，不自动更换标识或重试写入。
