更新 /api/custom-oauth-provider/{id} 接口

PUT

/api/custom-oauth-provider/{id}

本地契约说明

路由：PUT /api/custom-oauth-provider/{id}

注册处理器：github.com/QuantumNous/new-api/controller.UpdateCustomOAuthProvider。

消费方：web_vue。

鉴权：Root。需要 Root 用户。权限不足时服务端返回 403。

字段状态：controller-confirmed-sensitive。字段为动态上游数据或回调负载时，文档会明确标记，不能补造 Schema。

页面/功能：系统认证设置页更新自定义 OAuth Provider。

前端传参：Provider 写入 DTO；client_secret 仅传新值时更新。

前端展示：更新后的非敏感 Provider。

调试：使用本操作的 x-debug 里的占位符；示例不含真实密码、API Key、签名、Cookie 或 Provider 密钥。

请求参数

Authorization

Bearer Token

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

Body 参数application/json必填

示例

{
    "name": "Example OIDC",
    "slug": "example-oidc",
    "client_id": "client-***",
    "client_secret": "<redacted-client-secret>",
    "authorization_endpoint": "https://issuer.example/authorize",
    "token_endpoint": "https://issuer.example/token",
    "scopes": "openid profile email",
    "enabled": true
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'http://api-dev.opensosen.cn/api/custom-oauth-provider/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Example OIDC",
    "slug": "example-oidc",
    "client_id": "client-***",
    "client_secret": "<redacted-client-secret>",
    "authorization_endpoint": "https://issuer.example/authorize",
    "token_endpoint": "https://issuer.example/token",
    "scopes": "openid profile email",
    "enabled": true
}'

返回响应

🟢200

application/json

管理端业务响应。HTTP 200 不代表业务成功，必须检查 success。

Bodyapplication/json

示例

{
    "success": true,
    "message": "",
    "data": {
        "id": 1,
        "name": "Example OIDC",
        "slug": "example-oidc",
        "client_id": "client-***",
        "enabled": true
    }
}

🟠401

🟠403

修改于 2026-08-14 17:19:51

读取 /api/custom-oauth-provider/{id} 接口

提交 /api/custom-oauth-provider/discovery 接口

更新 /api/custom-oauth-provider/{id} 接口

本地契约说明#

请求参数

请求示例代码

返回响应

本地契约说明