Authok管理API

更新身份源

PATCH

/api/v1/connections/{id}

身份源

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

string

身份源ID

必需

示例值:

con_FEjo2nfowjwFe2

Body 参数application/json

display_name

string

可读名称

可选

strategy

string

身份源策略

必需

options

object

可选

身份源配置(根据strategy不同，配置不同)

enabled_clients

array[string]

应用ID列表

可选

is_domain_connection

boolean

可选

realms

array[string]

可选

metadata

object

可选

元数据. 用户自定义

示例

{
    "strategy": "wechat:pc",
    "display_name": "微信PC登录",
    "enabled_clients": [
        "23joifjoiejoiwjoj3n2o",
        "32jfifjoiejoiwjoj3n2o"
    ],
    "options": {
        "app_key":"fjiefoe",
        "app_secret":"fijejowjo32j2"
    },
    "metadata": {}
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://..authok.cn/api/v1/connections/con_FEjo2nfowjwFe2' \
--header 'Content-Type: application/json' \
--data-raw '{
    "strategy": "wechat:pc",
    "display_name": "微信PC登录",
    "enabled_clients": [
        "23joifjoiejoiwjoj3n2o",
        "32jfifjoiejoiwjoj3n2o"
    ],
    "options": {
        "app_key":"fjiefoe",
        "app_secret":"fijejowjo32j2"
    },
    "metadata": {}
}'

返回响应

🟢200成功

application/json

Body

string

身份源ID

必需

name

string

身份源唯一标识

必需

strategy

string

必需

身份源策略(等同身份提供者标识符)

display_name

string | null

可读名称

必需

options

object

必需

身份源配置(根据strategy不同，配置不同)

metadata

object | null

必需

元数据, 用户自定义

enabled_clients

array[string]

开启的应用

必需

示例

{
    "id": "con_jfi3jo2jfojojfje23",
    "name": "wechat:pc",
    "strategy": "wechat:pc",
    "display_name": "微信PC登录",
    "options": {
        "app_key": "fjiefoe",
        "app_secret": "fijejowjo32j2"
    },
    "metadata": {},
    "enabled_clients": [
        "23joifjoiejoiwjoj3n2o",
        "32jfifjoiejoiwjoj3n2o"
    ]
}

根据ID查找身份源

删除身份源