feat: 文档更新
This commit is contained in:
miaosiyu
parent
c6e588dbae
commit
46b23df467
49
op/API.md
49
op/API.md
|
|
@ -31,7 +31,6 @@ POST /v1/users
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 用户名，唯一，不传后台自动生成
|
||||
username?: string;
|
||||
// 密码，不传后台生成默认密码
|
||||
|
|
@ -189,7 +188,6 @@ POST /v1/jobs/users-disable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
ids?: string;[];
|
||||
}
|
||||
```
|
||||
|
|
@ -220,7 +218,6 @@ POST /v1/jobs/users-enable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
ids?: string;[];
|
||||
}
|
||||
```
|
||||
|
|
@ -251,7 +248,6 @@ PATCH /v1/users/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 用户名，验证唯一
|
||||
username?: string;
|
||||
|
|
@ -330,7 +326,6 @@ DELETE /v1/users/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -368,7 +363,6 @@ DELETE /v1/users
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
ids?: string;[];
|
||||
}
|
||||
```
|
||||
|
|
@ -580,7 +574,6 @@ PATCH /v1/users/{id}/passwords
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
old_password: string;
|
||||
new_password: string;
|
||||
|
|
@ -621,7 +614,6 @@ GET /v1/user-stored-credentials
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
user_id?: number;
|
||||
provider_code?: string;
|
||||
idp_config_id?: number;
|
||||
|
|
@ -701,7 +693,6 @@ POST /v1/user-stored-credentials
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 社会化身份源code
|
||||
provider_code: string;
|
||||
// 社会化登录配置的ID
|
||||
|
|
@ -767,7 +758,6 @@ POST /v1/applications
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
name: string;
|
||||
// 1，自建应用，2模板应用（市场应用）
|
||||
type: string;
|
||||
|
|
@ -865,7 +855,6 @@ PATCH /v1/applications/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
name?: string;
|
||||
domain_sn?: string;
|
||||
|
|
@ -1316,7 +1305,6 @@ POST /v1/applications/{id}/enable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -1349,7 +1337,6 @@ POST /v1/applications/{id}/disable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -1382,7 +1369,6 @@ DELETE /v1/applications/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -1416,7 +1402,6 @@ POST /v1/applications/{id}/secrets
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -1517,7 +1502,6 @@ PATCH /v1/applications/{id}/configs
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 允许的登录方式，格式为：["password", "vercode"]
|
||||
allowed_login_method?: string;
|
||||
|
|
@ -1620,7 +1604,6 @@ POST /v1/applications/{id}/mfa
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 已配置的idp conn id
|
||||
config_id: string;
|
||||
|
|
@ -1652,7 +1635,6 @@ DELETE /v1/applications/{app_id}/mfa/{config_id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
config_id: string;
|
||||
}
|
||||
|
|
@ -1683,7 +1665,6 @@ POST /v1/applications/{id}/idp
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 已配置的idp conn id
|
||||
config_id: string;
|
||||
|
|
@ -1715,7 +1696,6 @@ DELETE /v1/applications/{app_id}/idp/{config_id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
config_id: string;
|
||||
}
|
||||
|
|
@ -1746,7 +1726,6 @@ POST /v1/applications/{app_id}/protocols/{protocol_type}/enable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
protocol_type: string;
|
||||
}
|
||||
|
|
@ -1779,7 +1758,6 @@ POST /v1/applications/{app_id}/protocols/{protocol_type}/disable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
protocol_type: string;
|
||||
}
|
||||
|
|
@ -1870,7 +1848,6 @@ PUT /v1/applications/{app_id}/protocols/{protocol_type}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
protocol_type: string;
|
||||
// 配置参数
|
||||
|
|
@ -1904,7 +1881,6 @@ POST /v1/applications/{id}/accounts
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
user_id: string;
|
||||
username: string;
|
||||
|
|
@ -1949,7 +1925,6 @@ PUT /v1/applications/{app_id}/accounts/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
id: string;
|
||||
user_id?: string;
|
||||
|
|
@ -1994,7 +1969,6 @@ POST /v1/applications/{app_id}/accounts/{id}/enable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
id: string;
|
||||
id: string;
|
||||
|
|
@ -2026,7 +2000,6 @@ POST /v1/applications/{app_id}/accounts/{id}/disable
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
id: string;
|
||||
}
|
||||
|
|
@ -2057,7 +2030,6 @@ DELETE /v1/applications/{app_id}/accounts/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
app_id: string;
|
||||
id: string;
|
||||
}
|
||||
|
|
@ -2519,7 +2491,6 @@ POST /v1/batch/auth-unit-rules
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
identities: {
|
||||
identity_id: string;
|
||||
identity_name: string;
|
||||
|
|
@ -2577,7 +2548,6 @@ PUT /v1/auth-units/{rid}/rules/{tid}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
rid: string;
|
||||
tid: string;
|
||||
resource: {
|
||||
|
|
@ -2835,7 +2805,6 @@ DELETE /v1/batch/auth-unit-rules
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
ids?: string;[];
|
||||
}
|
||||
```
|
||||
|
|
@ -2865,7 +2834,6 @@ POST /v1/resources
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 描述
|
||||
description?: string;
|
||||
// 资源代码
|
||||
|
|
@ -2910,7 +2878,6 @@ PUT /v1/resources/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 描述
|
||||
description?: string;
|
||||
|
|
@ -3055,7 +3022,6 @@ DELETE /v1/batch/resources
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
ids?: string;[];
|
||||
}
|
||||
```
|
||||
|
|
@ -3085,7 +3051,6 @@ POST /v1/resource-sets
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
X-Tenant-id: string;
|
||||
// 应用id
|
||||
application_id: string;
|
||||
|
|
@ -3122,7 +3087,6 @@ PUT /v1/resource-sets/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
X-Tenant-Id: string;
|
||||
id: string;
|
||||
// 集合代码
|
||||
|
|
@ -3240,7 +3204,6 @@ POST /v1/resource-sets/{id}/members
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
resource_id: number;
|
||||
resource_scope: string;
|
||||
|
|
@ -3276,7 +3239,6 @@ PUT /v1/resource-sets/{sid}/members/{mid}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
sid: string;
|
||||
mid: string;
|
||||
resource_id: number;
|
||||
|
|
@ -3513,7 +3475,6 @@ POST /v1/core-objects
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
object_display_name: string;
|
||||
// 固定值：tree
|
||||
object_type: string;
|
||||
|
|
@ -3625,7 +3586,6 @@ DELETE /v1/tree-nodes/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
object_code: string;
|
||||
}
|
||||
|
|
@ -3697,7 +3657,6 @@ PATCH /v1/core-objects/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
object_display_name: string;
|
||||
// 固定值：tree
|
||||
|
|
@ -3779,7 +3738,6 @@ DELETE /v1/core-objects/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
|
|
@ -3810,7 +3768,6 @@ POST /v1/tree-users
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 关联扩展信息
|
||||
relation_data?: string;
|
||||
// user_id
|
||||
|
|
@ -3849,7 +3806,6 @@ PATCH /v1/tree-users/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 移动节点move, 设置为默认关系as-default
|
||||
action: string;
|
||||
|
|
@ -4093,7 +4049,6 @@ DELETE /v1/tree-users/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
ids?: string;[];
|
||||
// 节点ID
|
||||
|
|
@ -4129,7 +4084,6 @@ DELETE /v1/tree-users
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 节点ID
|
||||
node_id: string;
|
||||
// 用户原始ID
|
||||
|
|
@ -4163,7 +4117,6 @@ POST /v1/tree-nodes
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
// 节点ID
|
||||
id?: string;
|
||||
arn?: string;
|
||||
|
|
@ -4232,7 +4185,6 @@ PATCH /v1/tree-nodes/{id}
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
// 开发者ID
|
||||
developer_id?: string;
|
||||
|
|
@ -4335,7 +4287,6 @@ DELETE /v1/tree-nodes/{id}/children
|
|||
``` ts
|
||||
|
||||
{
|
||||
Content-Type: string;
|
||||
id: string;
|
||||
object_code: string;
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue