创建 OAuth2 客户端

POST

/system/oauth2-client/create

创建 OAuth2 客户端

请求参数

Body 参数application/json

integer <int64>

编号

可选

示例值:

1024

clientId

string

客户端编号

必需

示例值:

tudou

secret

string

客户端密钥

必需

示例值:

fan

name

string

应用名

必需

示例值:

土豆

logo

string

应用图标

必需

示例值:

https://www.iocoder.cn/xx.png

description

string

应用描述

可选

示例值:

我是一个应用

status

integer

必需

状态，参见 CommonStatusEnum 枚举

示例值:

accessTokenValiditySeconds

integer

访问令牌的有效期

必需

示例值:

8640

refreshTokenValiditySeconds

integer

刷新令牌的有效期

必需

示例值:

8640000

redirectUris

array[string]

必需

可重定向的 URI 地址

示例值:

https://www.iocoder.cn

authorizedGrantTypes

array[string]

必需

授权类型，参见 OAuth2GrantTypeEnum 枚举

示例值:

password

scopes

array[string]

授权范围

可选

示例值:

user_info

autoApproveScopes

array[string]

自动通过的授权范围

可选

示例值:

user_info

authorities

array[string]

权限

可选

示例值:

system:user:query

resourceIds

array[string]

资源

可选

示例值:

1024

additionalInformation

string

附加信息

可选

示例值:

yunai: true

示例

{
    "id": 1024,
    "clientId": "tudou",
    "secret": "fan",
    "name": "土豆",
    "logo": "https://www.iocoder.cn/xx.png",
    "description": "我是一个应用",
    "status": 1,
    "accessTokenValiditySeconds": 8640,
    "refreshTokenValiditySeconds": 8640000,
    "redirectUris": "https://www.iocoder.cn",
    "authorizedGrantTypes": "password",
    "scopes": "user_info",
    "autoApproveScopes": "user_info",
    "authorities": "system:user:query",
    "resourceIds": "1024",
    "additionalInformation": "yunai: true"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/system/oauth2-client/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 1024,
    "clientId": "tudou",
    "secret": "fan",
    "name": "土豆",
    "logo": "https://www.iocoder.cn/xx.png",
    "description": "我是一个应用",
    "status": 1,
    "accessTokenValiditySeconds": 8640,
    "refreshTokenValiditySeconds": 8640000,
    "redirectUris": "https://www.iocoder.cn",
    "authorizedGrantTypes": "password",
    "scopes": "user_info",
    "autoApproveScopes": "user_info",
    "authorities": "system:user:query",
    "resourceIds": "1024",
    "additionalInformation": "yunai: true"
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

可选

data

integer <int64>

返回数据

可选

msg

string

可选

错误提示，用户可阅读

示例

{
  "code": 0,
  "data": 0,
  "msg": ""
}

修改于 2025-04-08 02:01:57

删除访问令牌

更新 OAuth2 客户端