更新自定义 OAuth 提供商

PUT

/api/v1/admin/oauth/providers/{slug}

更新时重新执行端点 scheme、IP 地址空间和连接时 DNS 解析边界校验；省略 Client Secret 时保留原值。

请求参数

Path 参数

Body 参数application/json必填

示例

{
    "name": "string",
    "slug": "string",
    "authorization_endpoint": "http://example.com",
    "token_endpoint": "http://example.com",
    "userinfo_endpoint": "http://example.com",
    "client_id": "string",
    "client_secret": "pa$$word",
    "scopes": [
        "string"
    ],
    "subject_claim": "sub",
    "email_claim": "email",
    "name_claim": "string",
    "email_verified_claim": "string",
    "client_auth_method": "basic",
    "expected_version": 1
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/api/v1/admin/oauth/providers/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "slug": "string",
    "authorization_endpoint": "http://example.com",
    "token_endpoint": "http://example.com",
    "userinfo_endpoint": "http://example.com",
    "client_id": "string",
    "client_secret": "pa$$word",
    "scopes": [
        "string"
    ],
    "subject_claim": "sub",
    "email_claim": "email",
    "name_claim": "string",
    "email_verified_claim": "string",
    "client_auth_method": "basic",
    "expected_version": 1
}'

返回响应

🟢200成功

application/json

更新成功；返回包含递增 state_version 的最新提供商摘要，省略 Client Secret 时保留原值

Bodyapplication/json

示例

{
    "id": 1,
    "name": "string",
    "slug": "string",
    "trust_model": "oauth2_userinfo",
    "callback_uri": "http://example.com",
    "authorization_endpoint": "http://example.com",
    "token_endpoint": "http://example.com",
    "userinfo_endpoint": "http://example.com",
    "client_id": "string",
    "scopes": [
        "string"
    ],
    "subject_claim": "string",
    "email_claim": "string",
    "name_claim": "string",
    "email_verified_claim": "string",
    "client_auth_method": "basic",
    "pkce_enabled": true,
    "status": "active",
    "state_version": 1,
    "client_secret_configured": true
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠409

🟠413

🟠415参数错误

🟠422参数错误

🔴503服务器故障

修改于 2026-10-01 05:59:34

创建自定义 OAuth 提供商

停用自定义 OAuth 提供商