# 提交插件账号凭据

```{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}/secret
```

## 调用前准备

准备目标工作区 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/secret" \
  -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" --slurpfile PLUGIN_SECRET_FIELDS_FILE "$PLUGIN_SECRET_FIELDS_FILE" '
{
  "expected_version": $CONNECTION_VERSION,
  "fields": $PLUGIN_SECRET_FIELDS_FILE[0]
}
')"
```

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

适用于 secret 或 provider_issued 驱动。fields 必须非空，每个值至多 65536 字节、值合计不超过 1 MiB，HTTP JSON 请求体整体另有 1 MiB 限制。先读取发布配置和当前连接版本。将所需凭据字段保存在 $PLUGIN_SECRET_FIELDS_FILE 指向的JSON 对象中。服务核验凭据后返回非敏感授权状态；字段与验证地址由发布配置决定，不能在此覆盖。

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `expected_version` | integer | 是 | 当前连接或安装的 version，必须大于 0。 |
| `fields` | object | 是 | 按所选 profile 声明的字段名提交字符串值，不允许重复键。 |
| `fields["凭据字段"]` | string | 条件必填 | 遵守 profile.fields 的 required 条件；已提交的值不能为空。 |

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

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

## 成功响应

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

```json
{
  "code": 0,
  "data": {
    "workspace_id": "workspace_example",
    "connection_id": "connection_example",
    "status": "ready",
    "generation": 1,
    "revision": 1,
    "connection_version": 1
  }
}
```

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

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 0。 |
| `data` | object | 当前动作返回的数据。 |
| `data.workspace_id` | string | 资源字段，详见[公共对象与状态](objects.md)。 |
| `data.connection_id` | string | 资源字段，详见[公共对象与状态](objects.md)。 |
| `data.status` | string | 当前状态；按本页条件及公共对象判断。 |
| `data.generation` | integer | 授权代次，断开时作为 expected_generation；未授权时可能为 0。 |
| `data.revision` | integer | 资源字段，详见[公共对象与状态](objects.md)。 |
| `data.connection_version` | integer | 资源字段，详见[公共对象与状态](objects.md)。 |

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

## 错误响应

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