idmesh-api-sdk-java/api/openapi.yaml

10856 lines
286 KiB
YAML
Raw Normal View History

// Filename: /Users/liur/work/api-sdk-gen/openapi-generator/src/main/resources/Java/openapi.mustache
2023-12-27 20:14:28 +08:00
openapi: 3.0.1
info:
description: ""
title: IDMesh-Dev
version: 1.0.0
servers:
- url: /
tags:
- name: 认证 API
- name: 管理 API
- name: 管理 API/用户
- name: 管理 API/应用
- name: 管理 API/权限及资源
- name: 管理 API/权限及资源/权限
- name: 管理 API/权限及资源/授权单元 & 授权规则
- name: 管理 API/权限及资源/资源 & 资源集合
- name: 管理 API/权限及资源/应用授权
- name: 管理 API/组织关系
- name: 管理 API/身份源
- name: 管理 API/KV 存储
- name: 管理 API/定时任务
- name: 管理 API/FaaSNode.js
paths:
/v1/users/{id}:
delete:
deprecated: false
description: ""
operationId: delete
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/delete_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除用户
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992496-run
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: get
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/get_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询用户详情
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992510-run
x-accepts: application/json
patch:
deprecated: false
description: ""
operationId: modify
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modify_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 编辑用户
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992506-run
x-content-type: application/json
x-accepts: application/json
/v1/users:
get:
deprecated: false
description: ""
operationId: list
parameters:
- description: ""
example: "10"
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: ""
example: "1"
explode: true
in: query
name: page_num
required: false
schema:
type: integer
style: form
- description: 默认按用户基础字段搜索当值为generic时全文检索
example: ""
explode: true
in: query
name: search_type
required: false
schema:
type: string
style: form
- description: 检索值
example: ""
explode: true
in: query
name: keyword
required: false
schema:
type: string
style: form
- description: 开始时间
explode: true
in: query
name: time_modified_from
required: false
schema:
type: string
style: form
- description: 结束时间
explode: true
in: query
name: time_modified_to
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/list_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询用户列表
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992507-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: create
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建用户
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992504-run
x-content-type: application/json
x-accepts: application/json
/v1/user-stored-credentials:
get:
deprecated: false
description: ""
operationId: getStoredCredentials
parameters:
- description: 用户id标识
example: ""
explode: true
in: query
name: user_id
required: false
schema:
type: number
style: form
- description: 社会化登录提供者的code
example: ""
explode: true
in: query
name: provider_code
required: false
schema:
type: string
style: form
- description: 社会化登录配置的ID
example: ""
explode: true
in: query
name: idp_config_id
required: false
schema:
type: number
style: form
- description: 社会化身份标识1约定此字段保存用户唯一标识如openid
example: ""
explode: true
in: query
name: id1
required: false
schema:
type: string
style: form
- description: 社会化身份标识2如unionid
example: ""
explode: true
in: query
name: id2
required: false
schema:
type: string
style: form
- description: 更多社会化身份标识
example: ""
explode: true
in: query
name: metadata
required: false
schema:
type: string
style: form
- description: 状态
example: ""
explode: true
in: query
name: status
required: false
schema:
type: string
style: form
- description: 用户名
explode: true
in: query
name: username
required: false
schema:
type: string
style: form
- description: 显示名
explode: true
in: query
name: display_name
required: false
schema:
type: string
style: form
- description: ""
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: ""
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: integer
style: form
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getStoredCredentials_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询用户存储凭证列表
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992521-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: createStoreCredential
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createStoreCredential_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/createStoreCredential_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建用户存储凭证
tags:
- User
x-apifox-folder: 管理 API/用户
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992520-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{id}:
delete:
deprecated: false
description: ""
operationId: delete
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/delete_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992530-run
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: get
parameters:
- description: 唯一标识
example: "11123321123321123321123"
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AppDetail'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992534-run
x-accepts: application/json
patch:
deprecated: false
description: ""
operationId: modify
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modify_request_1'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新应用基本信息
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992524-run
x-content-type: application/json
x-accepts: application/json
/v1/applications:
get:
deprecated: false
description: ""
operationId: list
parameters:
- description: 应用名称
explode: true
in: query
name: name
required: false
schema:
type: string
style: form
- description: 应用类型
example: ""
explode: true
in: query
name: type
required: false
schema:
type: string
style: form
- description: "排序,格式:字段名[顺序]"
example: "time_created[desc]"
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
- description: 应用类型列表,逗号分隔
example: "1,2"
explode: true
in: query
name: types
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/list_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用列表
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992526-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: create
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/create_request_1'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/create_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992525-run
x-content-type: application/json
x-accepts: application/json
/v1/application-templates:
get:
deprecated: false
description: ""
operationId: getTemplate
parameters:
- description: 应用名称
explode: true
in: query
name: name
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getTemplate_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用模板列表
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992527-run
x-accepts: application/json
/v1/application:
get:
deprecated: false
description: ""
operationId: getByDomain
parameters:
- description: 域名
example: sense
explode: true
in: query
name: domain
required: false
schema:
type: string
style: form
- description: 域名简写
explode: true
in: query
name: domain_sn
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AppDetail'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按条件查询应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992528-run
x-accepts: application/json
/v1/applications/{id}/enable:
post:
deprecated: false
description: ""
operationId: enable
parameters:
- description: 应用标识
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/enable_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 启用应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992529-run
x-accepts: application/json
/v1/applications/{id}/disable:
post:
deprecated: false
description: ""
operationId: disable
parameters:
- description: 应用标识
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/disable_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 禁用应用
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992531-run
x-accepts: application/json
/v1/applications/{id}/secrets:
post:
deprecated: false
description: ""
operationId: createSecrets
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/createSecrets_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 刷新应用安全码
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992532-run
x-accepts: application/json
/v1/applications/{id}/configs:
get:
deprecated: false
description: ""
operationId: getConfig
parameters:
- description: 应用ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getConfig_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用配置信息
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992535-run
x-accepts: application/json
patch:
deprecated: false
description: ""
operationId: modifyConfig
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modifyConfig_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新应用配置
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-57153234-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{id}/sso/disable:
post:
deprecated: false
description: ""
operationId: disableSSO
parameters:
- description: 应用标识
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 禁用应用单点登录
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992536-run
x-accepts: application/json
/v1/applications/{id}/sso/enable:
post:
deprecated: false
description: ""
operationId: enableSSO
parameters:
- description: 应用标识
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 启用应用单点登录
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992537-run
x-accepts: application/json
/v1/applications/{app_id}/protocols/{protocol_type}/disable:
post:
deprecated: false
description: ""
operationId: disableProtocol
parameters:
- description: 应用 id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 协议名称,如 oidc
explode: false
in: path
name: protocol_type
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 禁用应用认证协议
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992538-run
x-accepts: application/json
/v1/applications/{app_id}/idp/{config_id}:
delete:
deprecated: false
description: ""
operationId: deleteIDPConfig
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: ""
explode: false
in: path
name: config_id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除应用认证源
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992539-run
x-accepts: application/json
/v1/applications/{app_id}/protocols/{protocol_type}/enable:
post:
deprecated: false
description: ""
operationId: enableProtocol
parameters:
- description: 应用 id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 协议名称,如 oidc
example: oidc
explode: false
in: path
name: protocol_type
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 启用应用认证协议
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992540-run
x-accepts: application/json
/v1/applications/{id}/idp:
post:
deprecated: false
description: ""
operationId: createIDP
parameters:
- description: 应用id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object'
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建应用认证源
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992541-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{id}/protocols:
get:
deprecated: false
description: ""
operationId: getProtocols
parameters:
- description: 应用唯一标识ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: "启用状态 1, 0"
example: "1"
explode: true
in: query
name: status
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AppProtocal'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用认证协议列表
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992543-run
x-accepts: application/json
/v1/applications/{app_id}/protocols/{protocol_type}:
get:
deprecated: false
description: ""
operationId: getProtocol
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 单点类型cas、oauth2、saml、oidc、sxp
explode: false
in: path
name: protocol_type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AppProtocal'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用认证协议
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992544-run
x-accepts: application/json
put:
deprecated: false
description: |2
具体入参参考:[https://thoughts.teambition.com/workspaces/607401bc94422600473bb8a7/docs/62207129fb49bf000106a046](https://thoughts.teambition.com/workspaces/607401bc94422600473bb8a7/docs/62207129fb49bf000106a046)
operationId: modifyProtocol
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 单点类型cas、oauth2、saml、oidc、sxp
explode: false
in: path
name: protocol_type
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_1'
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新应用认证协议
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992547-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{id}/accounts:
post:
deprecated: false
description: ""
operationId: createAccount
parameters:
- description: 应用id
example: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createAccount_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992545-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{app_id}/accounts/{id}:
delete:
deprecated: false
description: ""
operationId: deleteAccount
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 子账号id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-51363577-run
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: getAccount
parameters:
- description: 应用id
example: ""
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 子账号id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AppSubAccount'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-113520248-run
x-accepts: application/json
put:
deprecated: false
description: ""
operationId: modifyAccount
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 子账号id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/modifyAccount_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/modify_200_response_1'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992546-run
x-content-type: application/json
x-accepts: application/json
/v1/auth-units/{id}:
get:
deprecated: false
description: ""
operationId: getAuthUnit
parameters:
- description: au id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/AuthUnit'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询授权单元
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992549-run
x-accepts: application/json
/v1/applications/{app_id}/accounts/{id}/disable:
post:
deprecated: false
description: ""
operationId: disableAccount
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 子账号id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
multipart/form-data:
schema:
properties: {}
type: object
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 禁用应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992550-run
x-content-type: multipart/form-data
x-accepts: application/json
/v1/applications/{app_id}/accounts/{id}/enable:
post:
deprecated: false
description: ""
operationId: enableAccount
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 子账号id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
explode: true
in: query
name: id
required: true
schema:
type: string
style: form
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 启用应用子账号
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992552-run
x-accepts: application/json
/v1/auth-units:
get:
deprecated: false
description: ""
operationId: getAuthUnits
parameters:
- description: 主体id
explode: true
in: query
name: identity_id
required: false
schema:
type: string
style: form
- description: 主体类型
example: ""
explode: true
in: query
name: identity_type
required: false
schema:
type: string
style: form
- description: 主体名称
example: ""
explode: true
in: query
name: identity_name
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: string
style: form
- description: 页大小默认20
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: string
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getAuthUnits_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取授权单元列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992553-run
x-accepts: application/json
/v1/privileges:
get:
deprecated: false
description: ""
operationId: getPrivileges
parameters:
- description: 主体id
example: ""
explode: true
in: query
name: identity_id
required: false
schema:
type: string
style: form
- description: 主体类型
example: ""
explode: true
in: query
name: identity_type
required: false
schema:
type: string
style: form
- description: 主体名称
example: ""
explode: true
in: query
name: identity_name
required: false
schema:
type: string
style: form
- description: 应用id
example: ""
explode: true
in: query
name: application_id
required: true
schema:
type: string
style: form
- description: "对象类型(可选值: data, api, ui, res_set, app"
example: ""
explode: true
in: query
name: object_type
required: false
schema:
type: string
style: form
- description: 对象代码
example: ""
explode: true
in: query
name: object_code
required: false
schema:
type: string
style: form
- description: "作用方式affect,deny"
explode: true
in: query
name: affect
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: string
style: form
- description: 页大小默认20
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: string
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getPrivileges_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取权限列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/权限
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992556-run
x-accepts: application/json
/v1/batch/auth-unit-rules:
delete:
deprecated: false
description: ""
operationId: deleteAuthUnitRules
parameters:
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/deleteAuthUnitRules_request'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 批量删除授权规则
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992558-run
x-content-type: application/json
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: createAuthUnitRules
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_2'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 批量创建授权规则
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992557-run
x-content-type: application/json
x-accepts: application/json
/v1/resources/{id}:
get:
deprecated: false
description: ""
operationId: getResource
parameters:
- description: 资源id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: 应用id
example: ""
explode: true
in: query
name: application_id
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getResource_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询资源
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992565-run
x-accepts: application/json
put:
deprecated: true
description: ""
operationId: modifyResource
parameters:
- description: 资源id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_3'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新资源
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: deprecated
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992559-run
x-content-type: application/json
x-accepts: application/json
/v1/auth-units/{rid}/rules/{tid}:
put:
deprecated: false
description: ""
operationId: modifyAuthUnit
parameters:
- description: AU id
explode: false
in: path
name: rid
required: true
schema:
type: string
style: simple
- description: 规则id
explode: false
in: path
name: tid
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_4'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新授权规则
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992560-run
x-content-type: application/json
x-accepts: application/json
/v1/resources:
get:
deprecated: false
description: ""
operationId: getResources
parameters:
- description: 应用id
example: ""
explode: true
in: query
name: application_id
required: true
schema:
type: string
style: form
- description: 资源类型
example: ""
explode: true
in: query
name: type
required: false
schema:
type: string
style: form
- description: 资源代码
example: ""
explode: true
in: query
name: code
required: false
schema:
type: string
style: form
- description: 是否查询包含全局资源
example: "true"
explode: true
in: query
name: include_global
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: string
style: form
- description: 页大小默认20
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: string
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getResources_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询资源列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: developing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992562-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: createResource
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_5'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_6'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建资源
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992561-run
x-content-type: application/json
x-accepts: application/json
/v1/auth-units/{rid}/rules:
get:
deprecated: false
description: ""
operationId: getAuthUnitsRules
parameters:
- description: AU id
explode: false
in: path
name: rid
required: true
schema:
type: string
style: simple
- description: 应用id
explode: true
in: query
name: application_id
required: false
schema:
type: string
style: form
- description: 规则类型
example: "res,res_set,data,ui,app"
explode: true
in: query
name: type
required: false
schema:
type: string
style: form
- description: 资源或资源集合code
example: ""
explode: true
in: query
name: code
required: false
schema:
type: string
style: form
- description: 只查询指定主体下的授权
example: "true"
explode: true
in: query
name: self_only
required: false
schema:
type: string
style: form
- description: "资源id当type=api,ui,data时有效"
example: ""
explode: true
in: query
name: resource_id
required: false
schema:
type: string
style: form
- description: 匹配所有资源当type=res时有效
example: "false"
explode: true
in: query
name: resource_match_all_resources
required: false
schema:
type: string
style: form
- description: 匹配所有资源操作当type=res时有效
example: "false"
explode: true
in: query
name: resource_match_all_actions
required: false
schema:
type: string
style: form
- description: 资源集合id当type=res_set
example: ""
explode: true
in: query
name: resource_set_id
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Au'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询授权单元下的授权规则列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992563-run
x-accepts: application/json
/v1/batch/resources:
delete:
deprecated: false
description: ""
operationId: deleteResources
parameters:
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/deleteResources_request'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除资源
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992566-run
x-content-type: application/json
x-accepts: application/json
/v1/resource-sets/{id}:
get:
deprecated: false
description: ""
operationId: getResourceSet
parameters:
- description: 资源集合id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceSet'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询资源集合
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992576-run
x-accepts: application/json
put:
deprecated: false
description: ""
operationId: modifyResourceSet
parameters:
- description: 集合id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
- description: 租户id
explode: false
in: header
name: X-Tenant-Id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_7'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新资源集合
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992571-run
x-content-type: application/json
x-accepts: application/json
/v1/resource-sets:
get:
deprecated: false
description: ""
operationId: getResourceSets
parameters:
- description: 集合代码
explode: true
in: query
name: code
required: false
schema:
type: string
style: form
- description: 应用id
example: ""
explode: true
in: query
name: application_id
required: true
schema:
type: string
style: form
- description: 查询是否包含全局资源集合
example: "true"
explode: true
in: query
name: include_global
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: string
style: form
- description: 页大小默认20
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: string
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getResourceSets_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询资源集合列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: developing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992575-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: createResourceSet
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
- description: 租户id
example: "123"
explode: false
in: header
name: X-Tenant-id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_8'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_9'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建资源集合
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992572-run
x-content-type: application/json
x-accepts: application/json
/v1/resource-sets/{id}/members:
post:
deprecated: false
description: ""
operationId: createResourceSetMember
parameters:
- description: 集合id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_10'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_11'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建资源集合成员
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992574-run
x-content-type: application/json
x-accepts: application/json
/v1/resource-sets/{sid}/members/{mid}:
get:
deprecated: false
description: ""
operationId: getResourceMember
parameters:
- description: 资源集合id
explode: false
in: path
name: sid
required: true
schema:
type: string
style: simple
- description: 成员id
explode: false
in: path
name: mid
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceSetMember'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 ID 查询资源集合成员
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992582-run
x-accepts: application/json
put:
deprecated: false
description: ""
operationId: modifyResourceSetMember
parameters:
- description: 资源集合id
explode: false
in: path
name: sid
required: true
schema:
type: string
style: simple
- description: 资源集合成员id
explode: false
in: path
name: mid
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_12'
responses:
"200":
content:
application/json:
schema:
properties: {}
title: empty object
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新资源集合成员
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992577-run
x-content-type: application/json
x-accepts: application/json
/v1/tree-nodes/{id}/parent:
get:
deprecated: false
description: ""
operationId: getNodeParent
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TreeNode'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询父节点
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992579-run
x-accepts: application/json
/v1/resource-sets/{sid}/members:
get:
deprecated: false
description: ""
operationId: getResourceMembers
parameters:
- description: 资源集合id
explode: false
in: path
name: sid
required: true
schema:
type: string
style: simple
- description: 资源代码
example: ""
explode: true
in: query
name: resource_code
required: false
schema:
type: string
style: form
- description: 资源类型
example: ""
explode: true
in: query
name: resource_type
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: string
style: form
- description: 页大小默认20
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: string
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getResourceMembers_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询资源集合成员列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/资源 & 资源集合
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992581-run
x-accepts: application/json
/v1/tree-nodes/{id}:
delete:
deprecated: false
description: 如果该节点有子节点则不可删除,需要先删除所有子节点。
operationId: deleteNode
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: 树对象code
example: org_tree
explode: true
in: query
name: object_code
required: true
schema:
type: string
style: form
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/deleteNode_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除节点
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992583-run
x-accepts: application/json
get:
deprecated: false
description: 根据ID查询节点信息
operationId: getNode
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/TreeNode'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询节点信息
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992600-run
x-accepts: application/json
patch:
deprecated: false
description: |2
移动节点修改parent_id
operationId: updateNode
parameters:
- description: 更新树节点
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updateNode_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/updateNode_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 编辑节点
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992597-run
x-content-type: application/json
x-accepts: application/json
/v1/core-objects:
get:
deprecated: false
description: ""
operationId: getOrganizations
parameters: []
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/getOrganizations_200_response_inner'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取组织关系列表
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992586-run
x-accepts: application/json
post:
deprecated: false
description: 创建组织关系的元数据,同时创建根节点
operationId: createOrganization
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createOrganization_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/createOrganization_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建组织关系
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992584-run
x-content-type: application/json
x-accepts: application/json
/v1/core-objects/{id}:
delete:
deprecated: false
description: 如果该组织关系有子节点则不可删
operationId: deleteOrganization
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
multipart/form-data:
schema:
properties: {}
type: object
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/deleteOrganization_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除组织关系
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992588-run
x-content-type: multipart/form-data
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: getOrganization
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
explode: true
in: query
name: code
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/getOrganization_200_response_inner'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取组织关系基本信息
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992587-run
x-accepts: application/json
patch:
deprecated: false
description: ""
operationId: updateOrganization
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updateOrganization_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/deleteOrganization_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 修改组织关系基本信息
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992585-run
x-content-type: application/json
x-accepts: application/json
/v1/tree-users:
delete:
deprecated: false
description: "移除用户,uri参数中的ID和json中的参数至少有其一"
operationId: deleteMembers
parameters:
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/deleteMembers_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/deleteOrganization_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 从节点移除用户
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-121323985-run
x-content-type: application/json
x-accepts: application/json
get:
deprecated: false
description: 根据用户id获取与用户关联的组织关系列表
operationId: getMembers
parameters:
- description: 用户ID
explode: true
in: query
name: user_id
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/getMembers_200_response_inner'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取与用户关联的组织关系列表
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992590-run
x-accepts: application/json
/v1/tree-nodes:
get:
deprecated: false
description: ""
operationId: getNodes
parameters:
- description: 组织编码
example: ""
explode: true
in: query
name: object_code
required: true
schema:
type: string
style: form
- description: 名字,支持前缀搜索
explode: true
in: query
name: name
required: false
schema:
type: string
style: form
- description: 编号
example: ""
explode: true
in: query
name: code
required: false
schema:
type: string
style: form
- description: 标签
explode: true
in: query
name: tag
required: false
schema:
type: string
style: form
- description: 更新时间起点
example: ""
explode: true
in: query
name: time_modified_from
required: false
schema:
type: string
style: form
- description: 更新时间终点,默认至今
example: ""
explode: true
in: query
name: time_modified_to
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TreeNode'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询节点信息列表
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992595-run
x-accepts: application/json
post:
deprecated: false
description: ""
operationId: createNode
parameters:
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/createNode_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/deleteOrganization_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建节点
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992591-run
x-content-type: application/json
x-accepts: application/json
/v1/tree-nodes/{id}/tree-users:
get:
deprecated: false
description: 根据组织节点ID获取成员信息列表
operationId: getNodeMembers
parameters:
- description: node id
example: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: 关联类型,用于区分多重关联
explode: true
in: query
name: relation_type
required: false
schema:
type: string
style: form
- description: 是否默认关系 1是0否
explode: true
in: query
name: is_default
required: false
schema:
type: string
style: form
- description: 用户显示名
explode: true
in: query
name: display_name
required: false
schema:
type: string
style: form
- description: 用户名,支持模糊搜索(仅前缀)
example: ""
explode: true
in: query
name: username
required: false
schema:
type: string
style: form
- description: |-
// mode - 低->高 bit
// 第1位是否获得指针节点所对应的真实结点1-是0-否
// 第2位是否展开WeakNode即节点中类型不同的节点1-展开0-不展开
// 第3位是否递归地展开节点不建议
example: "000"
explode: true
in: query
name: mode
required: false
schema:
type: string
style: form
- description: 起始页默认1
example: ""
explode: true
in: query
name: page_num
required: false
schema:
type: integer
style: form
- description: 页大小默认10
example: ""
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: "排序方式,格式:字段[排序方式]"
example: ""
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getNodeMembers_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取成员信息列表
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992593-run
x-accepts: application/json
/v1/tree-nodes/{id}/children:
get:
deprecated: false
description: ""
operationId: getChildrenNodes
parameters:
- description: ""
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: |-
// mode - 低->高 bit
// 第1位是否获得指针节点所对应的真实结点1-是0-否
// 第2位是否展开WeakNode即节点中类型不同的节点1-展开0-不展开
// 第3位是否递归地展开节点不建议
example: "001"
explode: true
in: query
name: mode
required: true
schema:
type: string
style: form
- description: 当id = 0时必填创建树时的object_code
explode: true
in: query
name: object_code
required: true
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TreeNode'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取子节点列表
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-35992603-run
x-accepts: application/json
/v1/tree-users/{id}:
patch:
deprecated: false
description: ""
operationId: updateMember
parameters:
- description: ""
example: 用户ID
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/updateMember_request'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object_13'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 更新用户节点
tags:
- Organization
x-apifox-folder: 管理 API/组织关系
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-49937043-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{id}/mfa:
post:
deprecated: false
description: ""
operationId: createMFA
parameters:
- description: 应用id
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
- description: ""
example: application/json
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/empty_object'
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 启用应用多因素认证配置
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-52293563-run
x-content-type: application/json
x-accepts: application/json
/v1/applications/{app_id}/mfa/{config_id}:
delete:
deprecated: false
description: ""
operationId: deleteMFA
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: ""
explode: false
in: path
name: config_id
required: true
schema:
type: string
style: simple
- description: ""
example: application/x-www-form-urlencoded
explode: false
in: header
name: Content-Type
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 禁用应用多因素认证配置
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-52293568-run
x-accepts: application/json
/v1/auth-unit-rules:
get:
deprecated: false
description: ""
operationId: queryAuthUnitsRules
parameters:
- description: 应用id
explode: true
in: query
name: application_id
required: false
schema:
type: string
style: form
- description: 规则类型
example: "api, ui, data, res_set, app"
explode: true
in: query
name: type
required: false
schema:
type: string
style: form
- description: 资源或资源集合code
explode: true
in: query
name: code
required: false
schema:
type: string
style: form
- description: 主体id
explode: true
in: query
name: identity_id
required: true
schema:
type: string
style: form
- description: 主体类型
example: "user, node"
explode: true
in: query
name: identity_type
required: true
schema:
type: string
style: form
- description: 主体名称
explode: true
in: query
name: identity_name
required: false
schema:
type: string
style: form
- description: 只查询指定主体下的授权
example: "true"
explode: true
in: query
name: self_only
required: false
schema:
type: string
style: form
- description: "资源id当type=api,ui,data时有效"
explode: true
in: query
name: resource_id
required: false
schema:
type: string
style: form
- description: 匹配所有资源当type=res时有效
explode: true
in: query
name: resource_match_all_resources
required: false
schema:
type: string
style: form
- description: 匹配所有资源操作当type=res时有效
explode: true
in: query
name: resource_match_all_actions
required: false
schema:
type: string
style: form
- description: 资源集合id当type=res_set
explode: true
in: query
name: resource_set_id
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Au'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询授权规则列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/授权单元 & 授权规则
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-58118129-run
x-accepts: application/json
/v1/batch/authz-apps:
post:
deprecated: false
description: ""
operationId: authorizeApplications
parameters:
- description: 租户id
example: ""
explode: false
in: header
name: X-Tenant-Id
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/authorizeApplications_request'
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-ignore-properties: []
x-apifox-orders: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 授权应用
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/应用授权
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-58768643-run
x-content-type: application/json
x-accepts: application/json
/v1/authz-apps:
get:
deprecated: false
description: ""
operationId: listAuthorizedApplications
parameters:
- description: 授权主体 id
example: ""
explode: true
in: query
name: identity_id
required: true
schema:
type: string
style: form
- description: 授权主体类型
example: user
explode: true
in: query
name: identity_type
required: true
schema:
type: string
style: form
- description: "应用类型: 0-默认应用 1-自建应用 2-模板应用 3-组件应用"
example: "1,3"
explode: true
in: query
name: type
required: false
schema:
type: string
style: form
- description: 租户id
example: ""
explode: false
in: header
name: X-Tenant-Id
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AuthzApp'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询已授权应用列表
tags:
- Permission
x-apifox-folder: 管理 API/权限及资源/应用授权
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-58769185-run
x-accepts: application/json
/v1/buckets:
get:
deprecated: false
description: ""
operationId: getBuckets
parameters:
- description: 最后一个bucket的名字
example: ""
explode: true
in: query
name: last
required: false
schema:
type: string
style: form
- description: 页大小
example: ""
explode: true
in: query
name: limit
required: false
schema:
type: integer
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Bucket'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取 Bucket 列表
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82059883-run
x-accepts: application/json
/v1/buckets/{bucket}:
delete:
deprecated: false
description: 删除bucket会间接删掉bucket下所有object
operationId: deleteBucket
parameters:
- description: bucket 名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-ignore-properties: []
x-apifox-orders: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除 Bucket
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82062974-run
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: getBucket
parameters:
- description: bucket 名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Bucket'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取 Bucket 详情
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82060551-run
x-accepts: application/json
/v1/buckets/{bucket}/objects:
get:
deprecated: false
description: ""
operationId: getObjects
parameters:
- description: bucket名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
- description: 最后一个object的名字
example: ""
explode: true
in: query
name: last
required: false
schema:
type: string
style: form
- description: 页大小
example: ""
explode: true
in: query
name: limit
required: false
schema:
type: integer
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Object'
type: array
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取 Object 列表
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82061508-run
x-accepts: application/json
post:
deprecated: false
description: |-
- 如果path中的bucket没有创建会默认创建
- 如果key已经存在会更新原有的值
operationId: saveObject
parameters:
- description: bucket名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/saveObject_request'
responses:
"200":
content:
application/json:
schema:
properties: {}
type: object
x-apifox-ignore-properties: []
x-apifox-orders: []
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 创建 Object
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82073109-run
x-content-type: application/json
x-accepts: application/json
/v1/buckets/{bucket}/objects/{key}:
delete:
deprecated: false
description: ""
operationId: deleteObject
parameters:
- description: bucket名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
- description:
explode: false
in: path
name: key
required: true
schema:
type: string
style: simple
- description: 将键名称作为前缀执行删除
example: "false"
explode: true
in: query
name: key_as_prefix
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 删除 Object
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82074159-run
x-accepts: application/json
get:
deprecated: false
description: ""
operationId: getObject
parameters:
- description: bucket名称
explode: false
in: path
name: bucket
required: true
schema:
type: string
style: simple
- description:
explode: false
in: path
name: key
required: true
schema:
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 获取 Object 详情
tags:
- Storage
x-apifox-folder: 管理 API/KV 存储
x-apifox-status: testing
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-82073166-run
x-accepts: application/json
/v1/applications/{app_id}/accounts:
get:
deprecated: false
description: ""
operationId: getAccountsByApp
parameters:
- description: 应用id
explode: false
in: path
name: app_id
required: true
schema:
type: string
style: simple
- description: 用户id
explode: true
in: query
name: user_id
required: false
schema:
type: string
style: form
- description: 账号状态 1-活跃 0-冻结
explode: true
in: query
name: acc_status
required: false
schema:
type: string
style: form
- description: 账号名称
example: ""
explode: true
in: query
name: acc_name
required: false
schema:
type: string
style: form
- description: 页数
explode: true
in: query
name: page_num
required: false
schema:
type: integer
style: form
- description: 页大小
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: 排序字段
example: "time_created[asc]"
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountsByApp_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 按 APP ID 查询应用子账号列表
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-116622678-run
x-accepts: application/json
/v1/application-accounts:
get:
deprecated: false
description: ""
operationId: getAccounts
parameters:
- description: 应用id
explode: true
in: query
name: app_id
required: false
schema:
type: string
style: form
- description: 用户id
explode: true
in: query
name: user_id
required: false
schema:
type: string
style: form
- description: 账号状态 1-活跃 0-冻结
explode: true
in: query
name: acc_status
required: false
schema:
type: string
style: form
- description: 账号名称
example: ""
explode: true
in: query
name: acc_name
required: false
schema:
type: string
style: form
- description: 页数
explode: true
in: query
name: page_num
required: false
schema:
type: integer
style: form
- description: 页大小
explode: true
in: query
name: page_size
required: false
schema:
type: integer
style: form
- description: 排序字段
example: "time_created[asc]"
explode: true
in: query
name: page_sort
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/getAccountsByApp_200_response'
description: 成功
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/get_400_response'
description: 参数错误
summary: 查询应用子账号列表
tags:
- App
x-apifox-folder: 管理 API/应用
x-apifox-status: released
x-run-in-apifox: https://apifox.com/web/project/1500707/apis/api-124695117-run
x-accepts: application/json
components:
schemas:
AppSubAccount:
example:
tenant_id: tenant_id
acc_source: acc_source
acc_status: acc_status
acc_password: acc_password
app_name: app_name
acc_name: acc_name
time_modified: time_modified
acc_name_displayed: acc_name_displayed
acc_sync_status: acc_sync_status
user_id: user_id
time_created: time_created
id: id
acc_prop: "{}"
app_id: app_id
developer_id: developer_id
username: username
properties:
id:
title: 账号id
type: string
user_id:
title: 用户id
type: string
username:
title: 账户名称
type: string
app_id:
title: 应用id
type: string
app_name:
title: 应用名称
type: string
acc_name:
type: string
acc_name_displayed:
type: string
acc_source:
type: string
developer_id:
type: string
tenant_id:
type: string
acc_password:
type: string
acc_status:
type: string
acc_sync_status:
type: string
acc_prop:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
time_created:
type: string
time_modified:
type: string
required:
- acc_name
- acc_name_displayed
- acc_password
- acc_prop
- acc_source
- acc_status
- acc_sync_status
- app_id
- app_name
- developer_id
- id
- tenant_id
- time_created
- time_modified
- user_id
- username
title: 应用子账号
type: object
x-apifox-orders:
- id
- user_id
- username
- app_id
- app_name
- acc_name
- acc_name_displayed
- acc_source
- developer_id
- tenant_id
- acc_password
- acc_status
- acc_sync_status
- acc_prop
- time_created
- time_modified
x-apifox-ignore-properties: []
x-apifox-folder: 应用
Job:
properties:
id:
title: 任务id
type: integer
cron_job_id:
title: 定时任务状态
type: string
cron_job_kind:
title: 定时任务类型
type: string
cron_job_name:
title: 定时任务名称
type: string
namespace:
title: 任务分组
type: string
name:
title: 任务名称
type: string
start_time:
description: 任务开始执行时间rfc3339格式
title: 开始时间
type: string
completion_time:
description: 任务结束执行时间rfc3339格式
title: 结束时间
type: string
status:
description: |-
- running 执行中
- failed 执行失败
- success 执行成功
title: 任务状态
type: string
time_started:
description: rfc3339
title: 任务开始时间
type: string
time_completed:
description: rfc3339
title: 任务完成时间
type: string
time_created:
description: rfc3339
title: 数据创建时间
type: string
time_modified:
description: rfc3339
title: 数据更新时间
type: string
required:
- cron_job_id
- cron_job_kind
- cron_job_name
- id
- name
- namespace
- start_time
- status
- time_created
- time_modified
title: 任务
type: object
x-apifox-orders:
- id
- cron_job_id
- cron_job_kind
- cron_job_name
- namespace
- name
- start_time
- completion_time
- status
- time_started
- time_completed
- time_created
- time_modified
x-apifox-ignore-properties: []
x-apifox-folder: 定时任务
Injection:
properties:
key:
title: 参数名
type: string
alias:
description: 注入时的别名,为空则为 key
title: 别名
type: string
value:
title: 参数值
type: string
required:
- key
- value
title: 注入参数
type: object
x-apifox-orders:
- key
- alias
- value
x-apifox-ignore-properties: []
x-apifox-folder: 定时任务
CronJob:
properties:
id:
title: 任务id
type: string
developer_id:
title: 开发者id
type: string
tenant_id:
title: 租户id
type: string
namespace:
description: 定时任务所属的命名空间,也可以当做分组
title: 命名空间
type: string
name:
title: 名称
type: string
descr:
title: 描述
type: string
tags:
items:
type: string
title: 标签
type: array
config:
description: json raw
properties: {}
title: 配置
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
kind:
title: 任务类型
type: string
from:
title: 生效时间
type: string
exec_frequency:
enum:
- monthly
- weekly
- daily
- hourly
- every_12_hour
- every_6_hour
- every_3_hour
- every_2_hour
- every_30_minute
title: 执行频率
type: string
x-apifox:
enumDescriptions:
monthly: 每月
weekly: 每周
daily: 每天
hourly: 每小时
every_12_hour: 每12小时
every_6_hour: 每6小时
every_3_hour: 每3小时
every_2_hour: 每2小时
every_30_minute: 每30分钟
exec_cmd:
title: 启动命令
type: string
injections:
items:
$ref: '#/components/schemas/Injection'
title: 注入参数
type: array
status:
description: |-
- running 运行中
- suspended 挂起
title: 任务状态
type: string
time_created:
description: rfc3339
title: 创建时间
type: string
time_modified:
description: rfc3339
title: 最近更新时间
type: string
required:
- config
- developer_id
- from
- id
- kind
- name
- namespace
- status
- tags
- tenant_id
- time_created
- time_modified
title: 定时任务
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- namespace
- name
- descr
- tags
- config
- kind
- from
- exec_frequency
- exec_cmd
- injections
- status
- time_created
- time_modified
x-apifox-ignore-properties: []
x-apifox-folder: 定时任务
Object:
example:
bucket: bucket
updated_at: updated_at
created_at: created_at
value: value
key: key
properties:
bucket:
title: bucket名称
type: string
key:
title:
type: string
value:
title:
type: string
updated_at:
description: rfc3339
title: 更新时间
type: string
created_at:
description: rfc3339
title: 创建时间
type: string
required:
- bucket
- created_at
- key
- updated_at
- value
title: 对象信息
type: object
x-apifox-orders:
- bucket
- key
- value
- updated_at
- created_at
x-apifox-ignore-properties: []
x-apifox-folder: kv
Bucket:
example:
bucket: bucket
data_size: 0
object_count: 6
properties:
bucket:
title: bucket名称
type: string
data_size:
description: 单位byte
title: 数据大小
type: integer
object_count:
title: 对象数量
type: integer
required:
- bucket
- data_size
- object_count
title: bucket信息
type: object
x-apifox-orders:
- bucket
- data_size
- object_count
x-apifox-ignore-properties: []
x-apifox-folder: kv
AuthzApp:
example:
tenant_id: tenant_id
time_modified: time_modified
access_url: access_url
name: name
access_policy: access_policy
logo: logo
time_created: time_created
enabled_protocols:
- enabled_protocols
- enabled_protocols
id: id
type: type
developer_id: developer_id
decr: decr
properties:
id:
title: ""
type: string
developer_id:
title: 开发者id
type: string
tenant_id:
title: 租户id
type: string
name:
title: 应用名称
type: string
type:
description: |-
- 0 默认应用
- 1 自建应用
- 2 模板应用
- 3 组件应用
title: 应用类型
type: string
access_policy:
title: 访问策略
type: string
decr:
title: 应用描述
type: string
logo:
description: base64编码
title: 应用logo
type: string
access_url:
title: 访问地址
type: string
enabled_protocols:
description: oidc/saml/sxp 等
items:
type: string
title: 启用的协议
type: array
time_modified:
description: rfc3339
title: 修改时间
type: string
time_created:
description: rfc3339
title: 创建时间
type: string
required:
- access_policy
- access_url
- developer_id
- id
- logo
- name
- tenant_id
- time_created
- time_modified
- type
title: 授权应用
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- name
- type
- access_policy
- decr
- logo
- access_url
- enabled_protocols
- time_modified
- time_created
x-apifox-ignore-properties: []
x-apifox-folder: 权限
tree_user:
description: 核心-树型对象(组织、角色等)用户关系表
properties:
id:
description: 全局唯一ID
maxLength: 20
minimum: 1
type: string
developer_id:
description: 开发者ID
maxLength: 20
type: string
tenant_id:
description: 租户ID
maxLength: 20
type: string
node_id:
description: 节点ID
maxLength: 20
type: string
user_id:
description: 用户ID
maxLength: 20
type: string
path:
description: 所属组织关系路径
type: string
display_name:
description: 显示名
maxLength: 50
type: string
username:
description: 用户名
maxLength: 30
type: string
relation_type:
description: 关联类型(用于区分多重关联)
maxLength: 5
type: string
relation_data:
description: 关联扩展信息
type: string
is_default:
description: 是否默认关系
maxLength: 5
type: string
time_created:
description: 创建时间
format: date-time
type: string
time_modified:
description: 修改时间
format: date-time
type: string
status:
description: 状态
maxLength: 10
type: string
required:
- developer_id
- display_name
- id
- node_id
- path
- status
- tenant_id
- time_created
- time_modified
- user_id
- username
title: tree_user
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- node_id
- user_id
- path
- display_name
- username
- relation_type
- relation_data
- is_default
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
x-apifox-folder: tree
CoreObject:
properties:
id:
title: id
type: string
object_display_name:
title: 组织名称
type: string
object_type:
description: ' 固定值tree'
title: '组织类型 '
type: string
object_code:
description: 唯一,不可改,外键关联引用
title: 组织编码
type: string
object_props:
title: 组织额外属性
type: string
is_default:
description: 是否默认组织关系1是0否
title: 是否默认组织关系
type: string
status:
title: 状态
type: string
developer_id:
title: 开发者ID
type: string
tenant_id:
title: 租户ID
type: string
time_created:
title: 创建时间
type: string
time_modified:
title: 最后修改时间
type: string
required:
- id
- object_code
- object_display_name
- object_type
type: object
x-apifox-orders:
- id
- object_display_name
- object_type
- object_code
- object_props
- is_default
- status
- developer_id
- tenant_id
- time_created
- time_modified
x-apifox-ignore-properties: []
x-apifox-folder: tree
ResourceSetMember:
example:
tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
properties:
id:
title: 成员id
type: string
set_id:
title: 集合id
type: string
developer_id:
title: 开发者id
type: string
tenant_id:
title: 租户id
type: string
resource_id:
title: 资源id
type: string
application_id:
title: 应用id
type: string
application_name:
title: 应用名称
type: string
is_global:
title: 是否为全局
type: boolean
resource_type:
title: 资源类型
type: string
resource_code:
title: 资源代码
type: string
resource_scope:
title: 作用范围
type: string
resource_actions:
$ref: '#/components/schemas/ResourceSetMember_resource_actions'
selected_resource_actions:
items:
type: string
title: 选中的操作列表
type: array
match_all_resource_actions:
title: 匹配所有资源操作
type: boolean
time_modified:
title: 更新时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
required:
- match_all_resource_actions
title: 资源集合成员
type: object
x-apifox-orders:
- id
- set_id
- developer_id
- tenant_id
- resource_id
- application_id
- application_name
- is_global
- resource_type
- resource_code
- resource_scope
- resource_actions
- selected_resource_actions
- match_all_resource_actions
- time_modified
- time_created
x-apifox-ignore-properties: []
x-apifox-folder: 权限
TreeNode:
example:
tenant_id: tenant_id
sys_code: sys_code
code: code
is_pointer: is_pointer
operator_id: operator_id
description: description
perm_namespace_arn: perm_namespace_arn
sys_ext_props: "{}"
pointer_id: pointer_id
time_modified: time_modified
condition: condition
parent_id: parent_id
name: name
is_dynamic: is_dynamic
time_created: time_created
object_code: object_code
id: id
tag: tag
free_ext_props: "{}"
arn: arn
developer_id: developer_id
seq: 0
status: status
properties:
id:
description: 节点ID
title: 节点ID
type: string
developer_id:
description: 开发者ID
title: 开发者ID
type: string
tenant_id:
description: 租户ID
title: 租户ID
type: string
arn:
type: string
time_created:
description: 创建时间
title: 创建时间
type: string
tag:
description: 用于定义节点类型目前支持org组织role角色position岗位group
title: 标签
type: string
status:
description: 状态
title: 状态
type: string
is_pointer:
description: 是否指针类型
title: 是否指针类型
type: string
code:
description: 节点code
title: 节点code
type: string
name:
description: 节点名字
title: 节点名字
type: string
perm_namespace_arn:
description: 抽象权限容器的ARN
title: 抽象权限容器的ARN
type: string
condition:
type: string
is_dynamic:
description: 是否动态节点0普通结点1动态结点
title: 是否动态节点0普通结点1动态结点
type: string
sys_code:
description: 系统code
title: 系统code
type: string
operator_id:
description: 操作者id
title: 操作者id
type: string
pointer_id:
description: 指针指向的实体节点
title: 指针指向的实体节点
type: string
seq:
description: 序号
title: 序号
type: integer
description:
description: 描述
title: 描述
type: string
time_modified:
description: 最后修改时间
title: 最后修改时间
type: string
object_code:
description: OBJ_ID组织角色岗位职级等
title: 节点类型
type: string
parent_id:
description: 父节点id
title: 父节点id
type: string
sys_ext_props:
description: 额外属性需要先定义schema
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: 可以自由扩展
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
required:
- code
- name
- object_code
- sys_code
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- arn
- time_created
- tag
- status
- is_pointer
- code
- name
- perm_namespace_arn
- condition
- is_dynamic
- sys_code
- operator_id
- pointer_id
- seq
- description
- time_modified
- object_code
- parent_id
- sys_ext_props
- free_ext_props
x-apifox-ignore-properties: []
x-apifox-folder: tree
ResourceSet:
example:
time_modified: time_modified
application_name: application_name
code: code
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
properties:
id:
title: 集合id
type: string
application_id:
title: 应用id
type: string
application_name:
title: 应用名
type: string
is_global:
title: 是否为全局
type: boolean
code:
title: 集合代码
type: string
description:
title: 集合描述
type: string
time_modified:
title: 更新时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
title: 资源集合
type: object
x-apifox-orders:
- id
- application_id
- application_name
- is_global
- code
- description
- time_modified
- time_created
x-apifox-ignore-properties: []
x-apifox-folder: 权限
Au:
example:
code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
properties:
id:
title: 规则id
type: string
auth_unit_id:
title: au id
type: string
resource:
properties: {}
title: 授权的资源
type: object
resource_set:
$ref: '#/components/schemas/Au_resource_set'
affect:
description: allow/deny
title: 作用
type: string
resource_type:
description: 当resource存在时
title: 资源类型
type: string
code:
description: |-
当 resource 存在时表示 resource_code
当 resource_set存在时表示 resource_set_code
title: 代码
type: string
description:
title: 描述
type: string
application_name:
title: 应用名称
type: string
identity_id:
title: 授权主体id
type: string
identity_type:
title: 授权主体类型
type: string
identity_name:
title: 授权主体名称
type: string
inherited:
title: 是否为继承权限
type: boolean
required:
- affect
- application_name
- auth_unit_id
- code
- id
- identity_id
- identity_name
- identity_type
- inherited
type: object
x-apifox-orders:
- id
- auth_unit_id
- resource
- resource_set
- affect
- resource_type
- code
- description
- application_name
- identity_id
- identity_type
- identity_name
- inherited
x-apifox-ignore-properties: []
x-apifox-folder: 权限
AuthUnitResourceSet:
properties:
id:
title: 集合id
type: string
application_id:
title: 应用id
type: string
application_name:
title: 应用名
type: string
is_global:
title: 是否为全局
type: boolean
code:
title: 集合代码
type: string
description:
title: 集合描述
type: string
time_modified:
title: 更新时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
members:
items:
$ref: '#/components/schemas/ResourceSetMember'
title: 资源集合成员
type: array
match_all_resources:
title: 匹配所有资源
type: boolean
title: 授权规则-资源集合
type: object
x-apifox-refs:
"01GM5JSBCWH4GJZ55YRM77XNJY":
$ref: '#/components/schemas/ResourceSet'
x-apifox-overrides: {}
x-apifox-orders:
- 01GM5JSBCWH4GJZ55YRM77XNJY
- members
- match_all_resources
x-apifox-ignore-properties:
- id
- application_id
- application_name
- is_global
- code
- description
- time_modified
- time_created
x-apifox-folder: 权限
AuthUnitResouce:
properties:
id:
title: 资源id
type: string
developer_id:
title: 开发者id
type: string
tenant_id:
title: 租户id
type: string
application_id:
title: 应用id
type: string
applicatioin_name:
title: 应用名称
type: string
is_global:
title: 是否为全局
type: boolean
description:
title: 描述
type: string
type:
title: 类型
type: string
code:
title: 代码
type: string
uri:
title: uri
type: string
time_modified:
title: 修改时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
scope:
title: 授权范围
type: string
selected_actions:
items:
type: string
nullable: true
title: 选中的操作code列表
type: array
match_all_actions:
nullable: true
title: 匹配所有操作
type: boolean
match_all_resources:
nullable: true
title: 匹配所有资源
type: boolean
required:
- applicatioin_name
- application_id
- code
- description
- developer_id
- id
- is_global
- scope
- tenant_id
- time_created
- time_modified
- type
title: 授权规则-资源
type: object
x-apifox-refs:
"01GM5JMNJ5JCQ4K1TQVRA62TTB":
$ref: '#/components/schemas/Resource'
x-apifox-overrides: {}
x-apifox-orders:
- 01GM5JMNJ5JCQ4K1TQVRA62TTB
- scope
- selected_actions
- match_all_actions
- match_all_resources
x-apifox-ignore-properties:
- id
- developer_id
- tenant_id
- application_id
- applicatioin_name
- is_global
- description
- type
- code
- uri
- time_modified
- time_created
x-apifox-folder: 权限
Resource:
properties:
id:
title: 资源id
type: string
developer_id:
title: 开发者id
type: string
tenant_id:
title: 租户id
type: string
application_id:
title: 应用id
type: string
applicatioin_name:
title: 应用名称
type: string
is_global:
title: 是否为全局
type: boolean
description:
title: 描述
type: string
type:
title: 类型
type: string
code:
title: 代码
type: string
uri:
title: uri
type: string
time_modified:
title: 修改时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
required:
- applicatioin_name
- application_id
- code
- description
- developer_id
- id
- is_global
- tenant_id
- time_created
- time_modified
- type
title: 资源
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- application_id
- applicatioin_name
- is_global
- description
- type
- code
- uri
- time_modified
- time_created
x-apifox-ignore-properties: []
x-apifox-folder: 权限
AuthRuleArg:
properties:
resource:
$ref: '#/components/schemas/empty_object_4_resource'
resource_set:
$ref: '#/components/schemas/empty_object_4_resource_set'
application:
$ref: '#/components/schemas/empty_object_4_application'
affect:
description: allow/deny
title: 生效
type: string
owner_app_id:
description: 用于标识应用(尤其是在使用全局资源的场景下)
title: 应用id
type: string
required:
- affect
- owner_app_id
title: 授权规则参数
type: object
x-apifox-orders:
- resource
- resource_set
- application
- affect
- owner_app_id
x-apifox-ignore-properties: []
x-apifox-folder: 权限
IdentityObj:
properties:
identity_id:
title: 实体id
type: string
identity_name:
title: 实体名称
type: string
identity_type:
description: user 用户 programmer 编程者node 组织/自定义关系
title: 实体类型
type: string
required:
- identity_id
- identity_name
- identity_type
title: 授权实体
type: object
x-apifox-orders:
- identity_id
- identity_name
- identity_type
x-apifox-ignore-properties: []
x-apifox-folder: 权限
Privilege:
example:
time_modified: time_modified
affect_scope: affect_scope
identity_id: identity_id
object_type: object_type
affect: affect
auth_unit_rule_id: auth_unit_rule_id
time_created: time_created
object_code: object_code
id: 1.4658129805029452
identity_type: identity_type
application_id: application_id
properties:
id:
type: number
identity_type:
title: 主体类型
type: string
identity_id:
title: 主体id
type: string
auth_unit_rule_id:
title: 授权条目id
type: string
application_id:
title: 应用id
type: string
object_type:
title: 对象类型
type: string
object_code:
title: 对象代码
type: string
affect_scope:
title: 作用范围
type: string
affect:
title: 作用
type: string
time_created:
title: 创建时间 rfc3339
type: string
time_modified:
title: 更新时间 rfc3339
type: string
required:
- affect
- affect_scope
- application_id
- auth_unit_rule_id
- id
- identity_id
- identity_type
- object_code
- object_type
- time_created
- time_modified
title: 权限
type: object
x-apifox-orders:
- id
- identity_type
- identity_id
- auth_unit_rule_id
- application_id
- object_type
- object_code
- affect_scope
- affect
- time_created
- time_modified
x-apifox-ignore-properties: []
x-apifox-folder: 权限
AuthUnit:
example:
time_modified: time_modified
identity_id: identity_id
identity_name: identity_name
time_created: time_created
rules:
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
id: id
identity_type: identity_type
properties:
id:
type: string
identity_id:
title: 实体id
type: string
identity_name:
title: 实体名称
type: string
identity_type:
description: user 用户 programmer 编程者node 组织/自定义关系
title: 实体类型
type: string
rules:
items:
$ref: '#/components/schemas/Au'
type: array
time_created:
type: string
time_modified:
type: string
required:
- id
- identity_id
- identity_name
- identity_type
- rules
- time_created
- time_modified
title: 授权单元
type: object
x-apifox-refs:
"01GM5KEFTGBVMW86QJ45QB5BFK":
$ref: '#/components/schemas/IdentityObj'
x-apifox-overrides: {}
x-apifox-orders:
- id
- 01GM5KEFTGBVMW86QJ45QB5BFK
- rules
- time_created
- time_modified
x-apifox-ignore-properties:
- identity_id
- identity_name
- identity_type
x-apifox-folder: 权限
AppProtocal:
example: {}
properties: {}
title: 应用协议
type: object
x-apifox-ignore-properties: []
x-apifox-orders: []
x-apifox-folder: 应用
AppDetail:
example:
tenant_id: tenant_id
type: type
domain_sn: domain_sn
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
domain: domain
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
protocols:
- {}
- {}
app_id: app_id
app_secret: app_secret
sub_account_policy: 0
config: "{}"
developer_id: developer_id
redirect_url: redirect_url
status: status
properties:
id:
description: 唯一标识
type: string
developer_id:
description: 开发者ID
type: string
tenant_id:
description: 租户ID
type: string
name:
description: 应用名称
type: string
type:
description: 应用类型1自建应用2市场应用
type: string
app_id:
description: APPID
type: string
category:
description: 应用分类1 标准web应用2单页web应用3客户端应用4后端服务
type: string
app_secret:
description: APPSEC开发者用户调用返回
type: string
descr:
description: 应用描述
type: string
logo:
description: logo路径
type: string
login_url:
description: 登录路径
type: string
domain:
description: 应用绑定的唯一域名
type: string
domain_sn:
description: 应用域名 SN
type: string
redirect_url:
description: 重定向url
type: string
logout_url:
description: 登出url
type: string
sub_account_policy:
description: 子账号策略
type: integer
prop:
description: 扩展属性
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
time_created:
description: 创建时间
type: string
time_modified:
description: 更新时间
type: string
status:
description: 状态1启用0禁用
type: string
config:
properties: {}
type: object
x-apifox-overrides: {}
protocols:
items:
$ref: '#/components/schemas/AppProtocal'
type: array
required:
- config
- developer_id
- tenant_id
title: 应用(单体查询)
type: object
x-apifox-overrides: {}
x-apifox-refs: {}
x-apifox-orders:
- id
- developer_id
- tenant_id
- name
- type
- app_id
- category
- app_secret
- descr
- logo
- login_url
- domain
- domain_sn
- redirect_url
- logout_url
- sub_account_policy
- prop
- time_created
- time_modified
- status
- config
- protocols
x-apifox-ignore-properties: []
x-apifox-folder: 应用
AppConfig:
properties:
id:
title: 唯一标识
type: string
app_id:
title: 应用ID
type: string
allowed_login_method:
description: "格式为:[\"password\", \"vercode\"]"
title: 允许的登录方式
type: string
default_login_method:
description: 格式为password
title: 默认登录方式
type: string
allowed_reg_method:
description: "格式为:[\"mobile\", \"email\"]"
title: 允许注册方式
type: string
default_reg_method:
description: 格式为mobile
title: 默认注册方式
type: string
access_policy:
description: "permitted,all"
title: 应用级访问控制权限
type: string
reg_policy:
title: 新用户注册策略
type: string
allowed_id_provider:
$ref: '#/components/schemas/AppConfig_allowed_id_provider'
sso_enabled:
title: 是否允许SSO
type: boolean
mfa_enabled:
title: 是否开启MFA
type: boolean
mfa_config:
$ref: '#/components/schemas/___MFA__'
access_control_enabled:
title: 是否开启访问控制
type: boolean
time_created:
title: 创建时间
type: string
time_modified:
title: 修改时间
type: string
status:
description: 1启用0禁用
title: 状态
type: string
required:
- access_control_enabled
- app_id
- id
- mfa_enabled
- sso_enabled
- status
- time_created
- time_modified
title: 应用配置
type: object
x-apifox-orders:
- id
- app_id
- allowed_login_method
- default_login_method
- allowed_reg_method
- default_reg_method
- access_policy
- reg_policy
- allowed_id_provider
- sso_enabled
- mfa_enabled
- mfa_config
- access_control_enabled
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
x-apifox-folder: 应用
App:
properties:
id:
description: 唯一标识
type: string
developer_id:
description: 开发者ID
type: string
tenant_id:
description: 租户ID
type: string
name:
description: 应用名称
type: string
type:
description: 应用类型1自建应用2市场应用
type: string
app_id:
description: APPID
type: string
category:
description: 应用分类1 标准web应用2单页web应用3客户端应用4后端服务
type: string
app_secret:
description: APPSEC开发者用户调用返回
type: string
descr:
description: 应用描述
type: string
logo:
description: logo路径
type: string
login_url:
description: 登录路径
type: string
domain:
description: 应用绑定的唯一域名
type: string
redirect_url:
description: 重定向url
type: string
logout_url:
description: 登出url
type: string
sub_account_policy:
description: 子账号策略
type: integer
prop:
description: 扩展属性
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
time_created:
description: 创建时间
type: string
time_modified:
description: 更新时间
type: string
status:
description: 状态1启用0禁用
type: string
required:
- developer_id
- tenant_id
title: 应用
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- name
- type
- app_id
- category
- app_secret
- descr
- logo
- login_url
- domain
- redirect_url
- logout_url
- sub_account_policy
- prop
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
x-apifox-folder: 应用
get_200_response:
example:
tenant_id: 5.962133916683182
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
password: password
user_type: user_type
id_provider_connection: 6.027456183070403
nickname: nickname
time_created: time_created
id: 0.8008281904610115
arn: arn
email: email
developer_id: 1.4658129805029452
ext_prop: "{}"
mobile: mobile
work_title: work_title
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: 5.637376656633329
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
properties:
id:
description: 用户id标识
type: number
username:
description: 用户名,唯一
type: string
password:
description: 密码
type: string
display_name:
description: 显示名称
type: string
firstname:
description:
type: string
lastname:
description:
type: string
realname:
description: 真实姓名
type: string
pinyin:
description: 拼音
type: string
nickname:
description: 昵称
type: string
user_type:
description: 用户类型
type: string
mobile:
description: 手机
type: string
email:
description: 邮箱
type: string
gender:
description: 性别
type: string
cert_type:
description: 证件类型
type: string
cert_number:
description: 证件号
type: string
region:
description: 区域
type: string
work_time:
description: 加入时间
type: string
work_title:
description: 职位
type: string
ext_prop:
description: "扩展信息json对象{\"age\": 18, \"love\": \"足球\"}"
properties: {}
type: object
arn:
description: arn
type: string
id_provider_connection:
description: 身份源ID
type: number
developer_id:
description: 开发者id
type: number
tenant_id:
description: 租户id
type: number
last_login_ipaddr:
description: 上次登录IP
type: string
last_login_time:
description: 上次登录时间
type: string
time_created:
description: 创建时间
type: string
time_modified:
description: 修改时间
type: number
status:
description: 状态1正常0禁用
type: string
type: object
x-apifox-orders:
- id
- username
- password
- display_name
- firstname
- lastname
- realname
- pinyin
- nickname
- user_type
- mobile
- email
- gender
- cert_type
- cert_number
- region
- work_time
- work_title
- ext_prop
- arn
- id_provider_connection
- developer_id
- tenant_id
- last_login_ipaddr
- last_login_time
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
get_400_response:
properties:
code:
type: integer
errno:
type: integer
message:
type: string
required:
- code
- errno
- message
type: object
x-apifox-orders:
- code
- errno
- message
delete_200_response:
example:
errno: 6.027456183070403
code: 0.8008281904610115
data: 1.4658129805029452
message: message
properties:
code:
description: http状态码成功不显示
type: number
errno:
description: 返回错误码
type: number
message:
description: 返回描述
type: string
data:
description: 用户id
type: number
required:
- data
- errno
- message
type: object
x-apifox-orders:
- code
- errno
- message
- data
x-apifox-ignore-properties: []
modify_request:
properties:
username:
description: 用户名,验证唯一
type: string
display_name:
description: 显示名称
type: string
firstname:
description:
type: string
lastname:
description:
type: string
realname:
description: 真实姓名
type: string
pinyin:
description: 拼音
type: string
nickname:
description: 昵称
type: string
mobile:
description: 手机
type: string
email:
description: 邮箱
type: string
gender:
description: 性别1男0女
type: string
cert_type:
description: 证件类型
type: string
cert_number:
description: 证件号
type: string
region:
description: 区域
type: string
work_time:
description: 加入时间
type: string
work_title:
description: 职位
type: string
last_login_ipaddr:
description: 上次登录IP
type: string
last_login_time:
description: 上次登录时间
type: string
sys_ext_props:
description: "系统扩展信息json对象{\"age\": 18, \"love\": \"足球\"}"
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: 自由扩展属性json对象
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
type: object
x-apifox-orders:
- username
- display_name
- firstname
- lastname
- realname
- pinyin
- nickname
- mobile
- email
- gender
- cert_type
- cert_number
- region
- work_time
- work_title
- last_login_ipaddr
- last_login_time
- sys_ext_props
- free_ext_props
x-apifox-ignore-properties: []
modify_200_response:
example:
errno: 6.027456183070403
code: 0.8008281904610115
data: "{}"
message: message
properties:
code:
description: http状态码成功不显示
type: number
errno:
description: 返回错误码
type: number
message:
description: 返回描述
type: string
data:
description: 返回用户id
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
required:
- data
- errno
- message
type: object
x-apifox-orders:
- code
- errno
- message
- data
x-apifox-ignore-properties: []
list_200_response_data_inner:
example:
tenant_id: 5.962133916683182
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
password: password
user_type: user_type
id_provider_connection: 6.027456183070403
nickname: nickname
time_created: time_created
id: 0.8008281904610115
arn: arn
email: email
developer_id: 1.4658129805029452
ext_prop: "{}"
mobile: mobile
work_title: work_title
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: time_modified
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
properties:
id:
description: 用户id标识
type: number
username:
description: 用户名,唯一
type: string
password:
description: 密码
type: string
display_name:
description: 显示名称
type: string
firstname:
description:
type: string
lastname:
description:
type: string
realname:
description: 真实姓名
type: string
pinyin:
description: 拼音
type: string
nickname:
description: 昵称
type: string
user_type:
description: 用户类型
type: string
mobile:
description: 手机
type: string
email:
description: 邮箱
type: string
gender:
description: 性别
type: string
cert_type:
description: 证件类型
type: string
cert_number:
description: 证件号
type: string
region:
description: 区域
type: string
work_time:
description: 加入时间
type: string
work_title:
description: 职位
type: string
ext_prop:
description: "扩展信息json对象{\"age\": 18, \"love\": \"足球\"}"
properties: {}
type: object
arn:
description: arn
type: string
id_provider_connection:
description: 身份源ID
type: number
developer_id:
description: 开发者id
type: number
tenant_id:
description: 租户id
type: number
last_login_ipaddr:
description: 上次登录IP
type: string
last_login_time:
description: 上次登录时间
type: string
time_created:
description: 创建时间
type: string
time_modified:
description: 修改时间
type: string
status:
description: 状态1正常0禁用
type: string
required:
- id_provider_connection
- password
- status
- user_type
- username
type: object
x-apifox-orders:
- id
- username
- password
- display_name
- firstname
- lastname
- realname
- pinyin
- nickname
- user_type
- mobile
- email
- gender
- cert_type
- cert_number
- region
- work_time
- work_title
- ext_prop
- arn
- id_provider_connection
- developer_id
- tenant_id
- last_login_ipaddr
- last_login_time
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
list_200_response:
example:
data:
- tenant_id: 5.962133916683182
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
password: password
user_type: user_type
id_provider_connection: 6.027456183070403
nickname: nickname
time_created: time_created
id: 0.8008281904610115
arn: arn
email: email
developer_id: 1.4658129805029452
ext_prop: "{}"
mobile: mobile
work_title: work_title
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: time_modified
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
- tenant_id: 5.962133916683182
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
password: password
user_type: user_type
id_provider_connection: 6.027456183070403
nickname: nickname
time_created: time_created
id: 0.8008281904610115
arn: arn
email: email
developer_id: 1.4658129805029452
ext_prop: "{}"
mobile: mobile
work_title: work_title
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: time_modified
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
total_num: 5.637376656633329
page_num: 2.3021358869347655
properties:
data:
description: 返回用户列表
items:
$ref: '#/components/schemas/list_200_response_data_inner'
type: array
total_num:
description: 总数
type: number
page_num:
description: 当前页
type: number
type: object
x-apifox-orders:
- data
- total_num
- page_num
x-apifox-ignore-properties: []
create_request:
properties:
username:
description: 用户名,唯一,不传后台自动生成
type: string
password:
description: 密码,不传后台生成默认密码
type: string
password_status:
description: 密码状态valid/invalid
type: string
display_name:
description: 显示名称
type: string
firstname:
description:
type: string
lastname:
description:
type: string
realname:
description: 真实姓名
type: string
pinyin:
description: 拼音
type: string
nickname:
description: 昵称
type: string
user_type:
description: 用户类型,不传后台设置系统默认类型
type: string
mobile:
description: 手机
type: string
email:
description: 邮箱
type: string
gender:
description: 性别
type: string
cert_type:
description: 证件类型
type: string
cert_number:
description: 证件号
type: string
region:
description: 区域
type: string
work_time:
description: 加入时间
type: string
work_title:
description: 职位
type: string
idp_config_id:
description: 身份源ID作为创建时记录不做更新
type: number
sys_ext_props:
description: "系统扩展属性json对象{\"age\": 18, \"love\": \"足球\"}"
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: 自由扩展属性json对象
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
is_notify:
description: 是否通知默认不传false不通知true通知
type: boolean
required:
- idp_config_id
type: object
x-apifox-orders:
- username
- password
- password_status
- display_name
- firstname
- lastname
- realname
- pinyin
- nickname
- user_type
- mobile
- email
- gender
- cert_type
- cert_number
- region
- work_time
- work_title
- idp_config_id
- sys_ext_props
- free_ext_props
- is_notify
x-apifox-ignore-properties: []
_____null_inner:
example:
tenant_id: 5
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
sys_ext_props: "{}"
idp_config_id: 6
password: password
user_type: user_type
nickname: nickname
time_created: time_created
id: 0
free_ext_props: "{}"
arn: arn
email: email
developer_id: 1
mobile: mobile
work_title: work_title
avatar: "{}"
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: 5
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
properties:
id:
title: 用户id
type: integer
username:
title: 用户名
type: string
password:
title: 密码
type: string
display_name:
title: 显示名
type: string
firstname:
title:
type: string
lastname:
title:
type: string
realname:
title: 真实姓名
type: string
pinyin:
title: 拼音
type: string
nickname:
title: 昵称
type: string
avatar:
description: json对象
properties: {}
title: 头像
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
user_type:
title: 用户类型
type: string
mobile:
title: 手机
type: string
email:
title: 邮箱
type: string
gender:
title: 性别
type: string
cert_type:
title: 证件类型
type: string
cert_number:
title: 证件号
type: string
region:
title: 区域
type: string
work_time:
title: 加入时间
type: string
work_title:
title: 职位
type: string
arn:
title: ARN
type: string
idp_config_id:
title: 身份源
type: integer
developer_id:
title: 开发者
type: integer
tenant_id:
title: 租户
type: integer
last_login_ipaddr:
title: 上次登录IP
type: string
last_login_time:
title: 上次登录时间
type: string
time_created:
title: 创建时间
type: string
time_modified:
title: 更新时间
type: integer
status:
title: 状态
type: string
sys_ext_props:
description: json对象
properties: {}
required:
- 01HF94J4MK0QYT0D1X8YKBXB5B
title: 系统扩展属性
type: object
x-apifox-orders:
- 01HF94J4MK0QYT0D1X8YKBXB5B
x-apifox-ignore-properties: []
free_ext_props:
description: json对象
properties: {}
title: 自由扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
type: object
x-apifox-orders:
- id
- username
- password
- display_name
- firstname
- lastname
- realname
- pinyin
- nickname
- avatar
- user_type
- mobile
- email
- gender
- cert_type
- cert_number
- region
- work_time
- work_title
- arn
- idp_config_id
- developer_id
- tenant_id
- last_login_ipaddr
- last_login_time
- time_created
- time_modified
- status
- sys_ext_props
- free_ext_props
x-apifox-ignore-properties: []
getStoredCredentials_200_response:
example:
data:
- tenant_id: 5
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
sys_ext_props: "{}"
idp_config_id: 6
password: password
user_type: user_type
nickname: nickname
time_created: time_created
id: 0
free_ext_props: "{}"
arn: arn
email: email
developer_id: 1
mobile: mobile
work_title: work_title
avatar: "{}"
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: 5
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
- tenant_id: 5
firstname: firstname
cert_type: cert_type
gender: gender
last_login_time: last_login_time
sys_ext_props: "{}"
idp_config_id: 6
password: password
user_type: user_type
nickname: nickname
time_created: time_created
id: 0
free_ext_props: "{}"
arn: arn
email: email
developer_id: 1
mobile: mobile
work_title: work_title
avatar: "{}"
display_name: display_name
lastname: lastname
realname: realname
cert_number: cert_number
time_modified: 5
pinyin: pinyin
last_login_ipaddr: last_login_ipaddr
work_time: work_time
region: region
username: username
status: status
total_num: 2
page_num: 7
properties:
data:
items:
$ref: '#/components/schemas/_____null_inner'
title: 无数据返回null
type: array
total_num:
title: 无数据返回0
type: integer
page_num:
title: 无数据返回0
type: integer
required:
- data
- page_num
- total_num
type: object
x-apifox-orders:
- data
- total_num
- page_num
x-apifox-ignore-properties: []
createStoreCredential_request:
properties:
provider_code:
description: 社会化身份源code
type: string
idp_config_id:
description: 社会化登录配置的ID
type: number
id1:
description: 社会化身份标识1如openid
type: string
id2:
description: 社会化身份标识2如unionid
type: string
metadata:
description: 更多社会化身份标识
type: string
status:
description: 状态
type: string
nickname:
description: 昵称
type: string
avatar:
description: 头像
type: string
realname:
description: 真实姓名
type: string
mobile:
description: 手机
type: string
email:
description: 邮箱
type: string
gender:
description: 性别
type: string
id_provider_connection:
type: string
required:
- id1
- idp_config_id
- provider_code
type: object
x-apifox-orders:
- provider_code
- idp_config_id
- id1
- id2
- metadata
- status
- nickname
- avatar
- realname
- mobile
- email
- gender
- id_provider_connection
x-apifox-ignore-properties: []
createStoreCredential_200_response:
example:
errno: 6.027456183070403
code: 0.8008281904610115
data: data
message: message
properties:
code:
description: http状态码成功不显示
type: number
errno:
description: 返回错误码
type: number
message:
description: 返回描述
type: string
data:
description: 返回id标识
type: string
required:
- errno
- message
type: object
x-apifox-orders:
- code
- errno
- message
- data
x-apifox-ignore-properties: []
delete_200_response_1:
example:
data: "{}"
message: message
properties:
message:
type: string
data:
description: 结果标识true/false
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
type: object
x-apifox-orders:
- message
- data
x-apifox-ignore-properties: []
modify_request_1:
properties:
name:
title: 应用名称
type: string
domain_sn:
title: 应用 Domain SN
type: string
type:
description: 1自建应用2市场应用
title: 应用类型
type: string
app_id:
title: 应用key
type: string
app_secret:
title: 应用secret
type: string
category:
title: 应用分类
type: string
descr:
title: 应用描述
type: string
logo:
title: logo路径
type: string
login_url:
title: 登录路径
type: string
redirect_url:
title: 重定向路径
type: string
logout_url:
title: 登出路径
type: string
sub_account_policy:
title: 子账号策略
type: string
sys_ext_props:
properties: {}
title: 系统扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
properties: {}
title: 自定义扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
status:
description: 状态0禁用1启用
type: string
type: object
x-apifox-orders:
- name
- domain_sn
- type
- app_id
- app_secret
- category
- descr
- logo
- login_url
- redirect_url
- logout_url
- sub_account_policy
- sys_ext_props
- free_ext_props
- status
x-apifox-ignore-properties: []
modify_200_response_1:
example:
data: 0.8008281904610115
message: message
properties:
message:
type: string
data:
type: number
type: object
x-apifox-orders:
- message
- data
x-apifox-ignore-properties: []
list_200_response_1_data_inner_allowed_provider_id_inner:
example:
provider_type: provider_type
config_id: config_id
name: name
properties:
config_id:
title: 配置id
type: string
name:
title: 配置名
type: string
provider_type:
title: 提供者类型
type: string
required:
- config_id
- name
- provider_type
type: object
x-apifox-orders:
- config_id
- name
- provider_type
x-apifox-ignore-properties: []
list_200_response_1_data_inner:
example:
tenant_id: tenant_id
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
domain: domain
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
app_id: app_id
app_secret: app_secret
sub_account_policy: 0
developer_id: developer_id
redirect_url: redirect_url
status: status
allowed_provider_id:
- provider_type: provider_type
config_id: config_id
name: name
- provider_type: provider_type
config_id: config_id
name: name
properties:
id:
description: 唯一标识
type: string
developer_id:
description: 开发者ID
type: string
tenant_id:
description: 租户ID
type: string
name:
description: 应用名称
type: string
type:
description: 应用类型1自建应用2市场应用
type: string
app_id:
description: APPID
type: string
category:
description: 应用分类1 标准web应用2单页web应用3客户端应用4后端服务
type: string
app_secret:
description: APPSEC开发者用户调用返回
type: string
descr:
description: 应用描述
type: string
logo:
description: logo路径
type: string
login_url:
description: 登录路径
type: string
domain:
description: 应用绑定的唯一域名
type: string
redirect_url:
description: 重定向url
type: string
logout_url:
description: 登出url
type: string
sub_account_policy:
description: 子账号策略
type: integer
prop:
description: 扩展属性
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
time_created:
description: 创建时间
type: string
time_modified:
description: 更新时间
type: string
status:
description: 状态1启用0禁用
type: string
allowed_provider_id:
items:
$ref: '#/components/schemas/list_200_response_1_data_inner_allowed_provider_id_inner'
type: array
required:
- developer_id
- tenant_id
type: object
x-apifox-overrides: {}
x-apifox-refs:
"01GH8CB5VBK04ME1BCMZ8M487H":
$ref: '#/components/schemas/App'
x-apifox-overrides: {}
x-apifox-orders:
- 01GH8CB5VBK04ME1BCMZ8M487H
- allowed_provider_id
x-apifox-ignore-properties:
- id
- developer_id
- tenant_id
- name
- type
- app_id
- category
- app_secret
- descr
- logo
- login_url
- domain
- redirect_url
- logout_url
- sub_account_policy
- prop
- time_created
- time_modified
- status
list_200_response_1:
example:
data:
- tenant_id: tenant_id
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
domain: domain
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
app_id: app_id
app_secret: app_secret
sub_account_policy: 0
developer_id: developer_id
redirect_url: redirect_url
status: status
allowed_provider_id:
- provider_type: provider_type
config_id: config_id
name: name
- provider_type: provider_type
config_id: config_id
name: name
- tenant_id: tenant_id
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
domain: domain
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
app_id: app_id
app_secret: app_secret
sub_account_policy: 0
developer_id: developer_id
redirect_url: redirect_url
status: status
allowed_provider_id:
- provider_type: provider_type
config_id: config_id
name: name
- provider_type: provider_type
config_id: config_id
name: name
total_num: 6.027456183070403
current_page: 1.4658129805029452
properties:
data:
items:
$ref: '#/components/schemas/list_200_response_1_data_inner'
type: array
total_num:
type: number
current_page:
type: number
type: object
x-apifox-orders:
- data
- total_num
- current_page
x-apifox-ignore-properties: []
create_request_1_protocol_prop_response_attr_inner:
example:
nameFormat: nameFormat
attribute: attribute
value: value
properties:
value:
type: string
attribute:
type: string
nameFormat:
type: string
required:
- attribute
- nameFormat
- value
type: object
x-apifox-orders:
- value
- attribute
- nameFormat
x-apifox-ignore-properties: []
create_request_1_protocol_prop:
description: 默认 oidc 相关配置
properties:
acs_url:
type: string
sp_entity:
type: string
response_attr:
items:
$ref: '#/components/schemas/create_request_1_protocol_prop_response_attr_inner'
type: array
digest_algorithm:
type: string
lifetime_in_seconds:
type: number
signature_algorithm:
type: string
name_identifier_format:
type: string
authn_context_class_ref:
type: string
saml_response_signing_key:
type: string
saml_response_signing_cert:
type: string
saml_response_signing_cert_fingerprint:
type: string
title: 认证协议配置
type: object
x-apifox-orders:
- acs_url
- sp_entity
- response_attr
- digest_algorithm
- lifetime_in_seconds
- signature_algorithm
- name_identifier_format
- authn_context_class_ref
- saml_response_signing_key
- saml_response_signing_cert
- saml_response_signing_cert_fingerprint
x-apifox-ignore-properties: []
create_request_1_config_prop_access_policy:
example:
forget_password:
- forget_password
- forget_password
properties:
forget_password:
items:
type: string
type: array
type: object
x-apifox-orders:
- forget_password
x-apifox-ignore-properties: []
create_request_1_config_prop_allowed_login_method:
example:
name: name
properties:
name:
type: string
type: object
x-apifox-orders:
- name
x-apifox-ignore-properties: []
create_request_1_config_prop_allowed_social_login_provider:
example:
wechat_scan_qr: 5.962133916683182
dingding_scan_qr: 5.637376656633329
properties:
wechat_scan_qr:
type: number
dingding_scan_qr:
type: number
type: object
x-apifox-orders:
- wechat_scan_qr
- dingding_scan_qr
x-apifox-ignore-properties: []
create_request_1_config_prop:
properties:
status:
type: string
tenant_id:
type: string
mfa_config:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
reg_policy:
items:
type: string
type: array
mfa_enabled:
type: string
sso_enabled:
type: string
developer_id:
type: string
access_policy:
$ref: '#/components/schemas/create_request_1_config_prop_access_policy'
allowed_reg_method:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
default_reg_method:
type: string
allowed_login_method:
$ref: '#/components/schemas/create_request_1_config_prop_allowed_login_method'
default_login_method:
type: string
allowed_social_login_provider:
$ref: '#/components/schemas/create_request_1_config_prop_allowed_social_login_provider'
title: 应用配置
type: object
x-apifox-orders:
- status
- tenant_id
- mfa_config
- reg_policy
- mfa_enabled
- sso_enabled
- developer_id
- access_policy
- allowed_reg_method
- default_reg_method
- allowed_login_method
- default_login_method
- allowed_social_login_provider
x-apifox-ignore-properties: []
create_request_1:
properties:
name:
title: 应用名称
type: string
type:
description: 1自建应用2模板应用市场应用
title: 应用类型
type: string
domain_sn:
description: 域名
type: string
template_id:
description: 不填写则代表自建应用
title: 模板id
type: string
category:
description: 1 标准web应用2单页web应用3客户端应用4后端服务
title: 应用分类
type: string
descr:
title: 应用描述
type: string
logo:
description: 格式为http://ip:port/logo.png
title: logo路径
type: string
login_url:
title: 登录路径
type: string
redirect_url:
title: 重定向路径
type: string
logout_url:
title: 登出路径
type: string
sub_account_policy:
description: 1启用0不启用启用后单点登录返回
title: 子账号策略
type: string
sys_ext_props:
description: kv字典数据
properties: {}
title: 系统扩展字段
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: kv字典数据
properties: {}
title: 自定义扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
protocol_type:
description: 默认 oidc
title: 认证协议
type: string
protocol_prop:
$ref: '#/components/schemas/create_request_1_protocol_prop'
config_prop:
$ref: '#/components/schemas/create_request_1_config_prop'
required:
- category
- domain_sn
- free_ext_props
- name
- type
type: object
x-apifox-orders:
- name
- type
- domain_sn
- template_id
- category
- descr
- logo
- login_url
- redirect_url
- logout_url
- sub_account_policy
- sys_ext_props
- free_ext_props
- protocol_type
- protocol_prop
- config_prop
x-apifox-ignore-properties: []
create_200_response:
example:
id: id
properties:
id:
description: 唯一标识
type: string
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
getTemplate_200_response_data_inner_protocol_prop:
description: 单点登录协议属性
example:
digest_algorithm: digest_algorithm
authn_context_class_ref: authn_context_class_ref
lifetime_in_seconds: 6.027456183070403
response_attr:
- nameFormat: nameFormat
attribute: attribute
value: value
- nameFormat: nameFormat
attribute: attribute
value: value
saml_response_signing_key: saml_response_signing_key
signature_algorithm: signature_algorithm
sp_entity: sp_entity
name_identifier_format: name_identifier_format
saml_response_signing_cert_fingerprint: saml_response_signing_cert_fingerprint
saml_response_signing_cert: saml_response_signing_cert
acs_url: acs_url
properties:
acs_url:
type: string
sp_entity:
type: string
response_attr:
items:
$ref: '#/components/schemas/create_request_1_protocol_prop_response_attr_inner'
type: array
digest_algorithm:
type: string
lifetime_in_seconds:
type: number
signature_algorithm:
type: string
name_identifier_format:
type: string
authn_context_class_ref:
type: string
saml_response_signing_key:
type: string
saml_response_signing_cert:
type: string
saml_response_signing_cert_fingerprint:
type: string
type: object
x-apifox-orders:
- acs_url
- sp_entity
- response_attr
- digest_algorithm
- lifetime_in_seconds
- signature_algorithm
- name_identifier_format
- authn_context_class_ref
- saml_response_signing_key
- saml_response_signing_cert
- saml_response_signing_cert_fingerprint
x-apifox-ignore-properties: []
getTemplate_200_response_data_inner_config_prop:
description: 应用配置属性
example:
tenant_id: tenant_id
default_login_method: default_login_method
access_policy:
forget_password:
- forget_password
- forget_password
default_reg_method: default_reg_method
allowed_reg_method: "{}"
mfa_config: "{}"
sso_enabled: sso_enabled
reg_policy: 1.4658129805029452
allowed_login_method:
name: name
mfa_enabled: mfa_enabled
allowed_id_provider:
wechat_scan_qr: 5.962133916683182
dingding_scan_qr: 5.637376656633329
developer_id: developer_id
status: status
properties:
status:
type: string
tenant_id:
type: string
mfa_config:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
reg_policy:
type: number
mfa_enabled:
type: string
sso_enabled:
type: string
developer_id:
type: string
access_policy:
$ref: '#/components/schemas/create_request_1_config_prop_access_policy'
allowed_reg_method:
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
default_reg_method:
type: string
allowed_login_method:
$ref: '#/components/schemas/create_request_1_config_prop_allowed_login_method'
default_login_method:
type: string
allowed_id_provider:
$ref: '#/components/schemas/create_request_1_config_prop_allowed_social_login_provider'
type: object
x-apifox-orders:
- status
- tenant_id
- mfa_config
- reg_policy
- mfa_enabled
- sso_enabled
- developer_id
- access_policy
- allowed_reg_method
- default_reg_method
- allowed_login_method
- default_login_method
- allowed_id_provider
x-apifox-ignore-properties: []
getTemplate_200_response_data_inner:
example:
protocol_prop:
digest_algorithm: digest_algorithm
authn_context_class_ref: authn_context_class_ref
lifetime_in_seconds: 6.027456183070403
response_attr:
- nameFormat: nameFormat
attribute: attribute
value: value
- nameFormat: nameFormat
attribute: attribute
value: value
saml_response_signing_key: saml_response_signing_key
signature_algorithm: signature_algorithm
sp_entity: sp_entity
name_identifier_format: name_identifier_format
saml_response_signing_cert_fingerprint: saml_response_signing_cert_fingerprint
saml_response_signing_cert: saml_response_signing_cert
acs_url: acs_url
config_prop:
tenant_id: tenant_id
default_login_method: default_login_method
access_policy:
forget_password:
- forget_password
- forget_password
default_reg_method: default_reg_method
allowed_reg_method: "{}"
mfa_config: "{}"
sso_enabled: sso_enabled
reg_policy: 1.4658129805029452
allowed_login_method:
name: name
mfa_enabled: mfa_enabled
allowed_id_provider:
wechat_scan_qr: 5.962133916683182
dingding_scan_qr: 5.637376656633329
developer_id: developer_id
status: status
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
sub_account_policy: sub_account_policy
redirect_url: redirect_url
status: status
properties:
id:
description: 唯一标识
type: string
name:
description: 应用名称
type: string
type:
description: 应用类型1自建应用2市场应用
type: string
category:
description: 应用分类
type: string
descr:
description: 应用描述
type: string
logo:
description: logo路径
type: string
login_url:
description: 登录路径
type: string
redirect_url:
description: 重定向路径
type: string
logout_url:
description: 登出路径
type: string
sub_account_policy:
description: 子账号策略1启用2不启用
type: string
prop:
description: 扩展属性
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
protocol_prop:
$ref: '#/components/schemas/getTemplate_200_response_data_inner_protocol_prop'
config_prop:
$ref: '#/components/schemas/getTemplate_200_response_data_inner_config_prop'
time_created:
description: 创建事件
type: string
time_modified:
type: string
status:
type: string
type: object
x-apifox-orders:
- id
- name
- type
- category
- descr
- logo
- login_url
- redirect_url
- logout_url
- sub_account_policy
- prop
- protocol_prop
- config_prop
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
getTemplate_200_response:
example:
data:
- protocol_prop:
digest_algorithm: digest_algorithm
authn_context_class_ref: authn_context_class_ref
lifetime_in_seconds: 6.027456183070403
response_attr:
- nameFormat: nameFormat
attribute: attribute
value: value
- nameFormat: nameFormat
attribute: attribute
value: value
saml_response_signing_key: saml_response_signing_key
signature_algorithm: signature_algorithm
sp_entity: sp_entity
name_identifier_format: name_identifier_format
saml_response_signing_cert_fingerprint: saml_response_signing_cert_fingerprint
saml_response_signing_cert: saml_response_signing_cert
acs_url: acs_url
config_prop:
tenant_id: tenant_id
default_login_method: default_login_method
access_policy:
forget_password:
- forget_password
- forget_password
default_reg_method: default_reg_method
allowed_reg_method: "{}"
mfa_config: "{}"
sso_enabled: sso_enabled
reg_policy: 1.4658129805029452
allowed_login_method:
name: name
mfa_enabled: mfa_enabled
allowed_id_provider:
wechat_scan_qr: 5.962133916683182
dingding_scan_qr: 5.637376656633329
developer_id: developer_id
status: status
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
sub_account_policy: sub_account_policy
redirect_url: redirect_url
status: status
- protocol_prop:
digest_algorithm: digest_algorithm
authn_context_class_ref: authn_context_class_ref
lifetime_in_seconds: 6.027456183070403
response_attr:
- nameFormat: nameFormat
attribute: attribute
value: value
- nameFormat: nameFormat
attribute: attribute
value: value
saml_response_signing_key: saml_response_signing_key
signature_algorithm: signature_algorithm
sp_entity: sp_entity
name_identifier_format: name_identifier_format
saml_response_signing_cert_fingerprint: saml_response_signing_cert_fingerprint
saml_response_signing_cert: saml_response_signing_cert
acs_url: acs_url
config_prop:
tenant_id: tenant_id
default_login_method: default_login_method
access_policy:
forget_password:
- forget_password
- forget_password
default_reg_method: default_reg_method
allowed_reg_method: "{}"
mfa_config: "{}"
sso_enabled: sso_enabled
reg_policy: 1.4658129805029452
allowed_login_method:
name: name
mfa_enabled: mfa_enabled
allowed_id_provider:
wechat_scan_qr: 5.962133916683182
dingding_scan_qr: 5.637376656633329
developer_id: developer_id
status: status
type: type
descr: descr
logout_url: logout_url
time_modified: time_modified
login_url: login_url
prop: "{}"
name: name
logo: logo
time_created: time_created
id: id
category: category
sub_account_policy: sub_account_policy
redirect_url: redirect_url
status: status
total_num: 2.3021358869347655
current_page: 0.8008281904610115
properties:
current_page:
type: number
data:
items:
$ref: '#/components/schemas/getTemplate_200_response_data_inner'
type: array
total_num:
type: number
type: object
x-apifox-orders:
- current_page
- data
- total_num
x-apifox-ignore-properties: []
enable_200_response:
example:
data: 0.8008281904610115
message: message
properties:
message:
type: string
data:
description: 操作ID
type: number
required:
- data
- message
type: object
x-apifox-orders:
- message
- data
x-apifox-ignore-properties: []
disable_200_response:
example:
data: 0.8008281904610115
message: message
properties:
message:
type: string
data:
description: 操作ID
type: number
type: object
x-apifox-orders:
- message
- data
x-apifox-ignore-properties: []
createSecrets_200_response_data:
example:
appSecret: appSecret
id: id
properties:
appSecret:
description: 安全码
type: string
id:
description: 唯一标识
type: string
type: object
x-apifox-orders:
- appSecret
- id
x-apifox-ignore-properties: []
createSecrets_200_response:
example:
data:
appSecret: appSecret
id: id
message: message
properties:
message:
description: 操作结果
type: string
data:
$ref: '#/components/schemas/createSecrets_200_response_data'
type: object
x-apifox-orders:
- message
- data
x-apifox-ignore-properties: []
getConfig_200_response_mfa_config:
description: 开启的MFA配置
example:
provider_type: provider_type
config_id: config_id
name: name
properties:
name:
title: MFA配置名
type: string
provider_type:
title: 提供者类型
type: string
config_id:
title: 配置id
type: string
required:
- config_id
- name
- provider_type
type: object
x-apifox-orders:
- name
- provider_type
- config_id
x-apifox-ignore-properties: []
getConfig_200_response:
example:
default_login_method: default_login_method
access_policy: access_policy
default_reg_method: default_reg_method
allowed_reg_method: allowed_reg_method
time_modified: time_modified
mfa_config:
provider_type: provider_type
config_id: config_id
name: name
sso_enabled: true
reg_policy: reg_policy
allowed_login_method: allowed_login_method
time_created: time_created
mfa_enabled: true
id: id
app_id: app_id
allowed_id_provider: allowed_id_provider
status: status
properties:
id:
description: 唯一标识
type: string
app_id:
description: 应用ID
type: string
allowed_login_method:
description: "允许的登录方式,格式为:[\"password\", \"vercode\"]"
type: string
default_login_method:
description: 默认登录方式格式为password
type: string
allowed_reg_method:
description: "允许注册方式,格式为:[\"mobile\", \"email\"]"
type: string
default_reg_method:
description: 默认注册方式格式为mobile
type: string
access_policy:
description: "应用级访问控制权限,格式为:{\"password_recovery\": [\"email\"]}"
type: string
reg_policy:
description: "新用户注册策略是否允许自动注册注册验证方式等1是2否,"
type: string
allowed_id_provider:
description: "允许的登录身份提供商,格式为:{\"wechat_scan_qr\": 1, \"dingding_scan_qr\"\
:2}"
type: string
sso_enabled:
description: 是否允许SSO
type: boolean
mfa_enabled:
description: 是否开启MFA
type: boolean
mfa_config:
$ref: '#/components/schemas/getConfig_200_response_mfa_config'
time_created:
description: 创建时间
type: string
time_modified:
description: 修改时间
type: string
status:
description: 状态1启用0禁用
type: string
required:
- app_id
- default_login_method
- default_reg_method
- id
- sso_enabled
type: object
x-apifox-orders:
- id
- app_id
- allowed_login_method
- default_login_method
- allowed_reg_method
- default_reg_method
- access_policy
- reg_policy
- allowed_id_provider
- sso_enabled
- mfa_enabled
- mfa_config
- time_created
- time_modified
- status
x-apifox-ignore-properties: []
modifyConfig_request:
properties:
allowed_login_method:
description: "允许的登录方式,格式为:[\"password\", \"vercode\"]"
type: string
default_login_method:
description: 默认登录方式格式为password
type: string
allowed_reg_method:
description: "允许注册方式,格式为:[\"mobile\", \"email\"]"
type: string
default_reg_method:
description: 默认注册方式格式为mobile
title: ""
type: string
default_protocol:
description: 默认登录协议
title: ""
type: string
access_policy:
description: "应用级访问控制权限all: 所有人可访问 permitted: 拒绝未授权访问"
title: ""
type: string
reg_policy:
description: "新用户注册策略是否允许自动注册注册验证方式等1是2否,"
items:
type: string
type: array
title: 协议内容
type: object
x-apifox-orders:
- allowed_login_method
- default_login_method
- allowed_reg_method
- default_reg_method
- default_protocol
- access_policy
- reg_policy
x-apifox-ignore-properties: []
empty_object:
properties:
config_id:
description: 已配置的idp conn id
type: string
required:
- config_id
title: empty object
type: object
x-apifox-orders:
- config_id
x-apifox-ignore-properties: []
empty_object_1:
properties:
config_content:
description: 配置参数
properties: {}
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
title: empty object
type: object
x-apifox-orders:
- config_content
x-apifox-ignore-properties: []
createAccount_request:
properties:
user_id:
title: 用户唯一标识
type: string
username:
title: 用户名称
type: string
app_id:
title: 应用唯一标识
type: string
acc_name:
title: 帐号名
type: string
acc_name_displayed:
title: 显示名
type: string
acc_source:
title: 帐号来源
type: string
acc_password:
title: 帐号密码
type: string
acc_status:
description: 1启用0禁用
title: 帐号状态
type: string
sys_ext_props:
properties: {}
title: 系统扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
properties: {}
title: 自定义扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
required:
- acc_name
- acc_password
- acc_status
- app_id
- user_id
- username
type: object
x-apifox-orders:
- user_id
- username
- app_id
- acc_name
- acc_name_displayed
- acc_source
- acc_password
- acc_status
- sys_ext_props
- free_ext_props
x-apifox-ignore-properties: []
modifyAccount_request:
properties:
user_id:
title: 用户唯一标识
type: string
app_id:
title: 应用唯一标识
type: string
acc_name:
title: 帐号名
type: string
acc_name_displayed:
title: 显示名
type: string
acc_source:
title: 帐号来源
type: string
acc_password:
title: 密码
type: string
acc_status:
description: 1启用0禁用
title: 状态
type: string
sys_ext_props:
properties: {}
title: 系统扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
properties: {}
title: 自定义扩展属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
type: object
x-apifox-orders:
- user_id
- app_id
- acc_name
- acc_name_displayed
- acc_source
- acc_password
- acc_status
- sys_ext_props
- free_ext_props
x-apifox-ignore-properties: []
getAuthUnits_200_response:
example:
data:
- time_modified: time_modified
identity_id: identity_id
identity_name: identity_name
time_created: time_created
rules:
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
id: id
identity_type: identity_type
- time_modified: time_modified
identity_id: identity_id
identity_name: identity_name
time_created: time_created
rules:
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
- code: code
resource: "{}"
identity_id: identity_id
affect: affect
resource_type: resource_type
identity_name: identity_name
description: description
resource_set:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
application_name: application_name
inherited: true
auth_unit_id: auth_unit_id
id: id
identity_type: identity_type
id: id
identity_type: identity_type
total_num: 0.8008281904610115
properties:
total_num:
description: 总数量
type: number
data:
items:
$ref: '#/components/schemas/AuthUnit'
type: array
type: object
x-apifox-orders:
- total_num
- data
x-apifox-ignore-properties: []
getPrivileges_200_response:
example:
data:
- time_modified: time_modified
affect_scope: affect_scope
identity_id: identity_id
object_type: object_type
affect: affect
auth_unit_rule_id: auth_unit_rule_id
time_created: time_created
object_code: object_code
id: 1.4658129805029452
identity_type: identity_type
application_id: application_id
- time_modified: time_modified
affect_scope: affect_scope
identity_id: identity_id
object_type: object_type
affect: affect
auth_unit_rule_id: auth_unit_rule_id
time_created: time_created
object_code: object_code
id: 1.4658129805029452
identity_type: identity_type
application_id: application_id
total_num: 0.8008281904610115
current_page: 6.027456183070403
properties:
total_num:
description: 数据总数
type: number
current_page:
description: 当前页数(废弃)
type: number
data:
description: 数据列表
items:
$ref: '#/components/schemas/Privilege'
type: array
type: object
x-apifox-orders:
- total_num
- current_page
- data
x-apifox-ignore-properties: []
empty_object_2:
properties:
identities:
items:
$ref: '#/components/schemas/IdentityObj'
title: 授权实体列表
type: array
rules:
items:
$ref: '#/components/schemas/AuthRuleArg'
title: 授权规则列表
type: array
required:
- identities
- rules
title: empty object
type: object
x-apifox-orders:
- identities
- rules
x-apifox-ignore-properties: []
deleteAuthUnitRules_request:
properties:
ids:
items:
type: string
title: id列表
type: array
required:
- ids
type: object
x-apifox-orders:
- ids
x-apifox-ignore-properties: []
getResource_200_response:
example:
tenant_id: tenant_id
time_modified: time_modified
code: code
description: description
time_created: time_created
id: id
type: type
application_id: application_id
developer_id: developer_id
properties:
id:
description: 资源id
type: string
developer_id:
description: 开发者id
type: string
tenant_id:
description: 租户id
type: string
application_id:
description: 应用id
type: string
description:
description: 描述
type: string
type:
description: 类型
type: string
code:
description: 代码
type: string
time_modified:
description: 修改时间 rfc3339
type: string
time_created:
description: 创建时间 rfc3339
type: string
type: object
x-apifox-orders:
- id
- developer_id
- tenant_id
- application_id
- description
- type
- code
- time_modified
- time_created
x-apifox-ignore-properties: []
empty_object_3_actions_inner:
properties:
id:
description: 如果不携带id会认为是新创建的code
title: 资源id
type: string
code:
title: 资源代码
type: string
description:
title: 资源描述
type: string
required:
- code
type: object
x-apifox-orders:
- id
- code
- description
x-apifox-ignore-properties: []
empty_object_3:
properties:
description:
description: 描述
type: string
uri:
description: "资源URI, 当type=api/ui 时有效"
type: string
actions:
items:
$ref: '#/components/schemas/empty_object_3_actions_inner'
type: array
title: empty object
type: object
x-apifox-orders:
- description
- uri
- actions
x-apifox-ignore-properties: []
empty_object_4_resource:
nullable: true
properties:
id:
title: 资源id
type: string
scope:
title: 资源范围
type: string
actions:
items:
type: string
nullable: true
title: 选中的action code
type: array
match_all_actions:
nullable: true
title: 匹配所有资源操作
type: boolean
match_all_resources:
nullable: true
title: 匹配所有资源
type: boolean
application_id:
description: 当match_all_resources=true时必填
nullable: true
title: 应用id
type: string
application_name:
description: 当match_all_resources=true时必填
nullable: true
title: 应用名称
type: string
required:
- id
- scope
title: 资源
type: object
x-apifox-orders:
- id
- scope
- actions
- match_all_actions
- match_all_resources
- application_id
- application_name
x-apifox-ignore-properties: []
empty_object_4_resource_set:
nullable: true
properties:
id:
title: 资源集合id
type: string
required:
- id
title: 资源集合
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
empty_object_4_application:
nullable: true
properties:
id:
title: 应用id
type: string
required:
- id
title: 应用
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
empty_object_4:
properties:
resource:
$ref: '#/components/schemas/empty_object_4_resource'
resource_set:
$ref: '#/components/schemas/empty_object_4_resource_set'
application:
$ref: '#/components/schemas/empty_object_4_application'
affect:
description: allow/deny
title: 生效
type: string
required:
- affect
title: empty object
type: object
x-apifox-refs:
"01H6TT7YQ7MSQVTYNTFCZF053V":
$ref: '#/components/schemas/AuthRuleArg'
x-apifox-orders:
- 01H6TT7YQ7MSQVTYNTFCZF053V
x-apifox-ignore-properties:
- resource
- resource_set
- application
- affect
getResources_200_response:
example:
data:
- tenant_id: tenant_id
time_modified: time_modified
code: code
description: description
time_created: time_created
id: id
type: type
application_id: application_id
developer_id: developer_id
- tenant_id: tenant_id
time_modified: time_modified
code: code
description: description
time_created: time_created
id: id
type: type
application_id: application_id
developer_id: developer_id
total_num: 0.8008281904610115
properties:
total_num:
description: 数据总数
type: number
data:
items:
$ref: '#/components/schemas/getResource_200_response'
type: array
type: object
x-apifox-orders:
- total_num
- data
x-apifox-ignore-properties: []
empty_object_5_actions_inner:
properties:
code:
title: 资源代码
type: string
description:
title: 资源描述
type: string
required:
- code
type: object
x-apifox-orders:
- code
- description
x-apifox-ignore-properties: []
empty_object_5:
properties:
description:
description: 描述
type: string
code:
description: 资源代码
type: string
application_id:
description: 应用id
type: number
type:
description: 资源类型data/api/ui
type: string
uri:
description: "资源URI, 当type=api/ui 时有效"
type: string
actions:
items:
$ref: '#/components/schemas/empty_object_5_actions_inner'
type: array
required:
- application_id
- code
- type
title: empty object
type: object
x-apifox-orders:
- description
- code
- application_id
- type
- uri
- actions
x-apifox-ignore-properties: []
empty_object_6:
example:
resource_id: resource_id
properties:
resource_id:
description: 资源id
type: string
required:
- resource_id
title: empty object
type: object
x-apifox-orders:
- resource_id
x-apifox-ignore-properties: []
deleteResources_request:
properties:
ids:
items:
type: string
title: 资源id列表
type: array
required:
- ids
type: object
x-apifox-orders:
- ids
x-apifox-ignore-properties: []
empty_object_7:
properties:
code:
description: 集合代码
type: string
description:
description: 描述
type: string
required:
- code
- description
title: empty object
type: object
x-apifox-orders:
- code
- description
x-apifox-ignore-properties: []
getResourceSets_200_response:
example:
data:
- time_modified: time_modified
application_name: application_name
code: code
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
- time_modified: time_modified
application_name: application_name
code: code
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
total_num: 0.8008281904610115
properties:
total_num:
description: 数据总数
type: number
data:
items:
$ref: '#/components/schemas/ResourceSet'
type: array
type: object
x-apifox-orders:
- total_num
- data
x-apifox-ignore-properties: []
empty_object_8:
properties:
application_id:
description: 应用id
type: string
code:
description: 集合代码
type: string
description:
description: 描述
type: string
required:
- application_id
- code
title: empty object
type: object
x-apifox-orders:
- application_id
- code
- description
x-apifox-ignore-properties: []
empty_object_9:
example:
id: 0.8008281904610115
properties:
id:
type: number
required:
- id
title: empty object
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
empty_object_10:
properties:
resource_id:
title: 资源id
type: number
resource_scope:
title: 作用范围
type: string
resource_actions:
items:
type: string
title: 选中的操作
type: array
match_all_actions:
title: 是否匹配所有操作
type: boolean
required:
- match_all_actions
- resource_id
- resource_scope
title: empty object
type: object
x-apifox-orders:
- resource_id
- resource_scope
- resource_actions
- match_all_actions
x-apifox-ignore-properties: []
empty_object_11:
example:
member_id: member_id
properties:
member_id:
description: 成员id
type: string
required:
- member_id
title: empty object
type: object
x-apifox-orders:
- member_id
x-apifox-ignore-properties: []
empty_object_12_ResourceActions_inner:
properties:
id:
description: 操作id
type: number
code:
description: 操作代码
type: string
required:
- code
- id
type: object
x-apifox-orders:
- id
- code
x-apifox-ignore-properties: []
empty_object_12:
properties:
resource_id:
title: 资源id
type: number
resource_scope:
title: 作用范围
type: string
ResourceActions:
items:
$ref: '#/components/schemas/empty_object_12_ResourceActions_inner'
title: 操作列表
type: array
match_all_actions:
title: 匹配所有操作
type: boolean
required:
- match_all_actions
- resource_id
- resource_scope
title: empty object
type: object
x-apifox-orders:
- resource_id
- resource_scope
- ResourceActions
- match_all_actions
x-apifox-ignore-properties: []
getResourceMembers_200_response:
example:
data:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
total_num: 0.8008281904610115
properties:
total_num:
description: 数据总数
type: number
data:
items:
$ref: '#/components/schemas/ResourceSetMember'
type: array
type: object
x-apifox-orders:
- total_num
- data
x-apifox-ignore-properties: []
deleteNode_200_response:
example:
id: id
properties:
id:
title: 删除id
type: string
required:
- id
title: ""
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
updateNode_request:
properties:
developer_id:
description: 开发者ID
title: 开发者ID
type: string
tenant_id:
description: 租户ID
title: 租户ID
type: string
arn:
type: string
time_created:
description: 创建时间
title: 创建时间
type: string
tag:
description: 用于定义节点类型目前支持org组织role角色position岗位group
title: 标签
type: string
status:
description: 状态
title: 状态
type: string
is_pointer:
description: 是否指针类型
title: 是否指针类型
type: string
code:
description: 节点code
title: 节点code
type: string
name:
description: 节点名字
title: 节点名字
type: string
perm_namespace_arn:
description: 抽象权限容器的ARN
title: 抽象权限容器的ARN
type: string
condition:
type: string
is_dynamic:
description: 是否动态节点0普通结点1动态结点
title: 是否动态节点0普通结点1动态结点
type: string
sys_code:
description: 系统code
title: 系统code
type: string
operator_id:
description: 操作者id
title: 操作者id
type: string
pointer_id:
description: 指针指向的实体节点
title: 指针指向的实体节点
type: string
seq:
description: 序号
title: 序号
type: integer
description:
description: 描述
title: 描述
type: string
time_modified:
description: 最后修改时间
title: 最后修改时间
type: string
object_code:
description: OBJ_ID组织角色岗位职级等
title: 节点类型
type: string
parent_id:
description: 父节点id
title: 父节点id
type: string
sys_ext_props:
description: 额外属性需要先定义schema
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: 可以自由扩展
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
required:
- code
- name
- object_code
- sys_code
type: object
x-apifox-refs:
"01H9QF5NX9500WJFKCS9HVVFT6":
$ref: '#/components/schemas/TreeNode'
x-apifox-overrides: {}
x-apifox-orders:
- 01H9QF5NX9500WJFKCS9HVVFT6
x-apifox-ignore-properties:
- developer_id
- tenant_id
- arn
- time_created
- tag
- status
- is_pointer
- code
- name
- perm_namespace_arn
- condition
- is_dynamic
- sys_code
- operator_id
- pointer_id
- seq
- description
- time_modified
- object_code
- parent_id
- sys_ext_props
- free_ext_props
updateNode_200_response:
example:
sys_code: sys_code
code: code
is_pointer: is_pointer
operator_id: 0.8008281904610115
description: description
perm_namespace_arn: perm_namespace_arn
pointer_id: 6.027456183070403
condition: condition
source_parent_id: 1.4658129805029452
name: name
is_dynamic: is_dynamic
dest_parent_id: 5.962133916683182
object_code: object_code
arn: arn
seq: 5.637376656633329
status: status
properties:
sys_code:
description: 系统分配的用于处理树型关系的编码
type: string
code:
description: 节点代码
type: string
is_pointer:
description: 是否指针节点0普通结点1指针结点
type: string
operator_id:
description: 操作人ID
type: number
description:
description: 备注
type: string
perm_namespace_arn:
description: 抽象权限容器的ARN
type: string
pointer_id:
description: 指针指向的实体节点
type: number
condition:
description: 动态节点的条件(如满足某后缀表达式)
type: string
source_parent_id:
description: 源上级节点ID根为0
type: number
dest_parent_id:
description: 目标上级节点ID根为0
type: number
name:
description: 节点名称
type: string
is_dynamic:
description: 是否动态节点0普通结点1动态结点
type: string
object_code:
description: 节点类型OBJ_ID组织角色岗位职级等
type: string
arn:
description: ARN
type: string
seq:
description: 显示顺序
type: number
status:
description: 状态
type: string
type: object
x-apifox-orders:
- sys_code
- code
- is_pointer
- operator_id
- description
- perm_namespace_arn
- pointer_id
- condition
- source_parent_id
- dest_parent_id
- name
- is_dynamic
- object_code
- arn
- seq
- status
x-apifox-ignore-properties: []
getOrganizations_200_response_inner:
example:
object_display_name: object_display_name
time_modified: time_modified
object_type: object_type
time_created: time_created
object_code: object_code
id: id
is_default: is_default
object_props: "{}"
status: status
properties:
id:
title: id
type: string
object_display_name:
title: 组织名称
type: string
object_type:
description: ' 固定值tree'
title: '组织类型 '
type: string
object_code:
description: 唯一,不可改,外键关联引用
title: 组织编码
type: string
object_props:
title: 组织额外属性
type: object
is_default:
description: 是否默认组织关系1是0否
title: 是否默认组织关系
type: string
status:
title: 状态
type: string
time_created:
title: 创建时间
type: string
time_modified:
title: 最后修改时间
type: string
required:
- id
- object_code
- object_display_name
- object_type
type: object
x-apifox-refs:
"01HDZZCJAZYSDQT71RKAE0F5FR":
$ref: '#/components/schemas/CoreObject'
x-apifox-overrides: {}
x-apifox-orders:
- 01HDZZCJAZYSDQT71RKAE0F5FR
x-apifox-ignore-properties:
- id
- object_display_name
- object_type
- object_code
- object_props
- is_default
- status
- time_created
- time_modified
createOrganization_request:
properties:
object_display_name:
title: 组织名称
type: string
object_type:
description: ' 固定值tree'
title: '组织类型 '
type: string
object_code:
description: 唯一,不可改,外键关联引用
title: 组织编码
type: string
object_props:
title: 组织额外属性
type: string
is_default:
description: 是否默认组织关系1是0否
title: 是否默认组织关系
type: string
status:
title: 状态
type: string
required:
- object_code
- object_display_name
- object_type
type: object
x-apifox-refs:
"01HDZZ8S0WZERVWG4M5ER3FX8Q":
$ref: '#/components/schemas/CoreObject'
x-apifox-overrides: {}
x-apifox-orders:
- 01HDZZ8S0WZERVWG4M5ER3FX8Q
x-apifox-ignore-properties:
- object_display_name
- object_type
- object_code
- object_props
- is_default
- status
createOrganization_200_response:
example:
id: id
properties:
id:
description: 创建ID
type: string
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
getOrganization_200_response_inner:
example:
object_display_name: object_display_name
time_modified: time_modified
object_type: object_type
time_created: time_created
object_code: object_code
id: id
is_default: is_default
object_props: "{}"
status: status
properties:
id:
title: id
type: string
object_display_name:
title: 组织名称
type: string
object_type:
description: ' 固定值tree'
title: '组织类型 '
type: string
object_code:
description: 唯一,不可改,外键关联引用
title: 组织编码
type: string
object_props:
title: 组织额外属性
type: object
is_default:
description: 是否默认组织关系1是0否
title: 是否默认组织关系
type: string
status:
title: 状态
type: string
time_created:
title: 创建时间
type: string
time_modified:
title: 最后修改时间
type: string
required:
- id
- object_code
- object_display_name
- object_type
type: object
x-apifox-refs:
"01HDZZHZEGXMT8C9NSA69GTAR8":
$ref: '#/components/schemas/CoreObject'
x-apifox-overrides: {}
x-apifox-orders:
- 01HDZZHZEGXMT8C9NSA69GTAR8
x-apifox-ignore-properties:
- id
- object_display_name
- object_type
- object_code
- object_props
- is_default
- status
- time_created
- time_modified
deleteOrganization_200_response:
example:
id: id
properties:
id:
type: string
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
updateOrganization_request:
properties:
object_display_name:
title: 组织名称
type: string
object_type:
description: ' 固定值tree'
title: '组织类型 '
type: string
object_props:
title: 组织额外属性
type: string
is_default:
description: 是否默认组织关系1是0否
title: 是否默认组织关系
type: string
status:
title: 状态
type: string
type: object
x-apifox-refs:
"01HDZZDW51C1N4EM81SST0J6EK":
$ref: '#/components/schemas/CoreObject'
x-apifox-overrides: {}
x-apifox-orders:
- 01HDZZDW51C1N4EM81SST0J6EK
x-apifox-ignore-properties:
- object_display_name
- object_type
- object_props
- is_default
- status
getMembers_200_response_inner:
example:
relation_data: relation_data
tree_node:
tenant_id: tenant_id
sys_code: sys_code
code: code
is_pointer: is_pointer
operator_id: operator_id
description: description
perm_namespace_arn: perm_namespace_arn
sys_ext_props: "{}"
pointer_id: pointer_id
time_modified: time_modified
condition: condition
parent_id: parent_id
name: name
is_dynamic: is_dynamic
time_created: time_created
object_code: object_code
id: id
tag: tag
free_ext_props: "{}"
arn: arn
developer_id: developer_id
seq: 0
status: status
relation_type: relation_type
display_name: display_name
is_default: is_default
path: path
time_modified: 2000-01-23T04:56:07.000+00:00
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
node_id: node_id
username: username
status: status
properties:
id:
description: 全局唯一ID
maxLength: 20
minimum: 1
type: string
node_id:
description: 节点ID
maxLength: 20
type: string
user_id:
description: 用户ID
maxLength: 20
type: string
path:
description: 所属组织关系路径
type: string
display_name:
description: 显示名
maxLength: 50
type: string
username:
description: 用户名
maxLength: 30
type: string
relation_type:
description: 关联类型(用于区分多重关联)
maxLength: 5
type: string
relation_data:
description: 关联扩展信息
type: string
is_default:
description: 是否默认关系
maxLength: 5
type: string
time_created:
description: 创建时间
format: date-time
type: string
time_modified:
description: 修改时间
format: date-time
type: string
status:
description: 状态
maxLength: 10
type: string
tree_node:
$ref: '#/components/schemas/TreeNode'
required:
- display_name
- id
- node_id
- path
- status
- time_created
- time_modified
- tree_node
- user_id
- username
type: object
x-apifox-refs:
"01HCEATVDAR92GJYBW675DWNJQ":
$ref: '#/components/schemas/tree_user'
x-apifox-overrides: {}
x-apifox-orders:
- 01HCEATVDAR92GJYBW675DWNJQ
- tree_node
x-apifox-ignore-properties:
- id
- node_id
- user_id
- path
- display_name
- username
- relation_type
- relation_data
- is_default
- time_created
- time_modified
- status
deleteMembers_request:
properties:
node_id:
description: 节点ID
title: 节点ID
type: string
user_id:
description: 用户原始ID
title: 用户ID
type: string
required:
- node_id
- user_id
type: object
x-apifox-orders:
- node_id
- user_id
x-apifox-ignore-properties: []
createNode_request:
properties:
id:
description: 节点ID
title: 节点ID
type: string
arn:
type: string
time_created:
description: 创建时间
title: 创建时间
type: string
tag:
description: 用于定义节点类型目前支持org组织role角色position岗位group
title: 标签
type: string
status:
description: 状态
title: 状态
type: string
is_pointer:
description: 是否指针类型
title: 是否指针类型
type: string
code:
description: 节点code
title: 节点code
type: string
name:
description: 节点名字
title: 节点名字
type: string
perm_namespace_arn:
description: 抽象权限容器的ARN
title: 抽象权限容器的ARN
type: string
condition:
type: string
is_dynamic:
description: 是否动态节点0普通结点1动态结点
title: 是否动态节点0普通结点1动态结点
type: string
sys_code:
description: 系统code
title: 系统code
type: string
operator_id:
description: 操作者id
title: 操作者id
type: string
pointer_id:
description: 指针指向的实体节点
title: 指针指向的实体节点
type: string
seq:
description: 序号
title: 序号
type: integer
description:
description: 描述
title: 描述
type: string
time_modified:
description: 最后修改时间
title: 最后修改时间
type: string
object_code:
description: OBJ_ID组织角色岗位职级等
title: 节点类型
type: string
parent_id:
description: 父节点id
title: 父节点id
type: string
sys_ext_props:
description: 额外属性需要先定义schema
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
free_ext_props:
description: 可以自由扩展
properties: {}
title: 额外属性
type: object
x-apifox-orders: []
x-apifox-ignore-properties: []
required:
- code
- name
- object_code
- sys_code
type: object
x-apifox-refs:
"01HE085ZPTX1XY9HEXGK3F2DCY":
$ref: '#/components/schemas/TreeNode'
x-apifox-overrides: {}
x-apifox-orders:
- 01HE085ZPTX1XY9HEXGK3F2DCY
x-apifox-ignore-properties:
- id
- arn
- time_created
- tag
- status
- is_pointer
- code
- name
- perm_namespace_arn
- condition
- is_dynamic
- sys_code
- operator_id
- pointer_id
- seq
- description
- time_modified
- object_code
- parent_id
- sys_ext_props
- free_ext_props
getNodeMembers_200_response_data_inner_node_info_inner:
example:
path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
properties:
id:
description: 全局唯一ID
maxLength: 20
minimum: 1
type: string
node_id:
description: 节点ID
maxLength: 20
type: string
user_id:
description: 用户ID
maxLength: 20
type: string
path:
description: 所属组织关系路径
type: string
display_name:
description: 显示名
maxLength: 50
type: string
username:
description: 用户名
maxLength: 30
type: string
relation_type:
description: 关联类型(用于区分多重关联)
maxLength: 5
type: string
relation_data:
description: 关联扩展信息
type: string
is_default:
description: 是否默认关系
maxLength: 5
type: string
time_created:
description: 创建时间
format: date-time
type: string
time_modified:
description: 修改时间
format: date-time
type: string
status:
description: 状态
maxLength: 10
type: string
required:
- display_name
- id
- node_id
- path
- status
- time_created
- time_modified
- user_id
- username
type: object
x-apifox-refs:
"01HCEAEVV90J9VKFTY9ZCHJH32":
$ref: '#/components/schemas/tree_user'
x-apifox-overrides: {}
x-apifox-orders:
- 01HCEAEVV90J9VKFTY9ZCHJH32
x-apifox-ignore-properties:
- id
- node_id
- user_id
- path
- display_name
- username
- relation_type
- relation_data
- is_default
- time_created
- time_modified
- status
getNodeMembers_200_response_data_inner:
example:
user_id: user_id
node_info:
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
display_name: display_name
username: username
properties:
user_id:
description: 用户ID
type: string
username:
description: 用户名
type: string
display_name:
description: 用户显示名
type: string
node_info:
description: 用户节点信息
items:
$ref: '#/components/schemas/getNodeMembers_200_response_data_inner_node_info_inner'
type: array
required:
- display_name
- node_info
- user_id
- username
type: object
x-apifox-orders:
- user_id
- username
- display_name
- node_info
x-apifox-ignore-properties: []
getNodeMembers_200_response:
example:
data:
- user_id: user_id
node_info:
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
display_name: display_name
username: username
- user_id: user_id
node_info:
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
- path: path
time_modified: 2000-01-23T04:56:07.000+00:00
relation_data: relation_data
user_id: user_id
time_created: 2000-01-23T04:56:07.000+00:00
id: id
relation_type: relation_type
display_name: display_name
is_default: is_default
node_id: node_id
username: username
status: status
display_name: display_name
username: username
total_num: 0
current_page: 6
properties:
total_num:
description: 总数
type: integer
current_page:
description: 当前页码
type: integer
data:
description: 数据
items:
$ref: '#/components/schemas/getNodeMembers_200_response_data_inner'
type: array
required:
- current_page
- data
- total_num
type: object
x-apifox-orders:
- total_num
- current_page
- data
x-apifox-ignore-properties: []
updateMember_request:
properties:
action:
description: "移动节点move, 设置为默认关系as-default"
title: 操作
type: string
is_default:
description: 1是0否
title: 是否默认关系
type: string
source_node_id:
description: 移动前节点ID
title: 原节点ID
type: string
dest_node_id:
description: 移动后节点ID
title: 目标节点ID
type: string
required:
- action
type: object
x-apifox-orders:
- action
- is_default
- source_node_id
- dest_node_id
x-apifox-ignore-properties: []
empty_object_13:
example:
id: id
properties:
id:
type: string
required:
- id
title: empty object
type: object
x-apifox-orders:
- id
x-apifox-ignore-properties: []
authorizeApplications_request:
properties:
identities:
items:
$ref: '#/components/schemas/IdentityObj'
title: 授权实体列表
type: array
application_id:
title: 应用id
type: string
affect:
description: "allow, deny"
title: 作用
type: string
required:
- affect
- application_id
- identities
type: object
x-apifox-orders:
- identities
- application_id
- affect
x-apifox-ignore-properties: []
saveObject_request:
properties:
key:
title:
type: string
value:
title:
type: string
required:
- key
- value
type: object
x-apifox-orders:
- key
- value
x-apifox-ignore-properties: []
getAccountsByApp_200_response:
example:
total: 0.8008281904610115
records:
- tenant_id: tenant_id
acc_source: acc_source
acc_status: acc_status
acc_password: acc_password
app_name: app_name
acc_name: acc_name
time_modified: time_modified
acc_name_displayed: acc_name_displayed
acc_sync_status: acc_sync_status
user_id: user_id
time_created: time_created
id: id
acc_prop: "{}"
app_id: app_id
developer_id: developer_id
username: username
- tenant_id: tenant_id
acc_source: acc_source
acc_status: acc_status
acc_password: acc_password
app_name: app_name
acc_name: acc_name
time_modified: time_modified
acc_name_displayed: acc_name_displayed
acc_sync_status: acc_sync_status
user_id: user_id
time_created: time_created
id: id
acc_prop: "{}"
app_id: app_id
developer_id: developer_id
username: username
properties:
records:
items:
$ref: '#/components/schemas/AppSubAccount'
type: array
total:
type: number
type: object
x-apifox-orders:
- records
- total
x-apifox-ignore-properties: []
ResourceSetMember_resource_actions:
example:
code: code
description: description
properties:
code:
title: 操作代码
type: string
description:
title: 操作描述
type: string
required:
- code
title: 操作代码
type: object
x-apifox-orders:
- code
- description
x-apifox-ignore-properties: []
Au_resource_set:
example:
time_modified: time_modified
application_name: application_name
code: code
members:
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
- tenant_id: tenant_id
resource_code: resource_code
resource_type: resource_type
is_global: true
match_all_resource_actions: true
application_id: application_id
time_modified: time_modified
application_name: application_name
resource_id: resource_id
resource_actions:
code: code
description: description
time_created: time_created
set_id: set_id
id: id
resource_scope: resource_scope
developer_id: developer_id
selected_resource_actions:
- selected_resource_actions
- selected_resource_actions
match_all_resources: true
is_global: true
description: description
time_created: time_created
id: id
application_id: application_id
properties:
id:
title: 集合id
type: string
application_id:
title: 应用id
type: string
application_name:
title: 应用名
type: string
is_global:
title: 是否为全局
type: boolean
code:
title: 集合代码
type: string
description:
title: 集合描述
type: string
time_modified:
title: 更新时间 rfc3339
type: string
time_created:
title: 创建时间 rfc3339
type: string
members:
items:
$ref: '#/components/schemas/ResourceSetMember'
title: 资源集合成员
type: array
match_all_resources:
title: 匹配所有资源
type: boolean
title: 授权的资源集合
type: object
x-apifox-refs:
"01GM5K7WQCCSJW6Y5CD88CQJXH":
x-apifox-overrides: {}
type: object
properties: {}
x-apifox-orders:
- 01GM5K7WQCCSJW6Y5CD88CQJXH
x-apifox-ignore-properties:
- id
- application_id
- application_name
- is_global
- code
- description
- time_modified
- time_created
- members
- match_all_resources
AppConfig_allowed_id_provider:
description: "格式为:{\"wechat_scan_qr\": 1, \"dingding_scan_qr\": 2}"
properties:
id:
title: ""
type: string
idp_code:
type: string
idp_config_id:
type: string
auth_method_code:
type: string
auth_method_display_name:
type: string
required:
- auth_method_code
- auth_method_display_name
- id
- idp_code
- idp_config_id
title: 允许的登录身份提供商
type: object
x-apifox-orders:
- id
- idp_code
- idp_config_id
- auth_method_code
- auth_method_display_name
x-apifox-ignore-properties: []
___MFA__:
properties:
name:
title: MFA配置名
type: string
provider_type:
title: 提供者类型
type: string
config_id:
title: 配置id
type: string
scenarios:
items:
type: string
title: 场景
type: array
required:
- config_id
- name
- provider_type
- scenarios
title: 开启的MFA配置
type: object
x-apifox-orders:
- name
- provider_type
- config_id
- scenarios
x-apifox-ignore-properties: []