跳转至

DomainAuthtimeController(企业域管理)

管理平台企业域/租户的完整生命周期:企业域的查询(分页 + 用户名/域名/自定义字段过滤)、单条详情、创建、更新、删除、父子域关系移除、自定义图标库(列表 / 删除)、企业微信同步开关显隐、LDAP 同步、域 Secret Key 重置、云能力中心 API Key 验证 / 保存 / 服务列表查询、域基础功能(系统模块)配置开关,以及天翎短信平台测试。

  • 类级基址:${myapps.context-path.manager:}/api/authtime(完整路径:{manager-context}/api/authtime<相对路径>)
  • Tag:企业域模块
  • 控制器源码:obpm-manager/src/main/java/cn/myapps/manager/authtime/controller/domain/DomainAuthtimeController.java
  • 公共说明:
  • 类继承 BaseAuthTimeController,通过其 success(errmsg, data) / error(errcode, errmsg, errors) 返回统一 Resource(字段 errcode/errmsg/data/errors,结构见 ../index.md「统一响应结构」)。
  • 多数端点在 try/catch 内捕获 Exception 并 e.printStackTrace() 后返回 errcode=500、errmsg=e.getMessage()、data=null(HTTP 状态码由 @ResponseStatus 决定,业务异常时仍为 200/201);业务校验失败常用 errcode=4001。
  • 鉴权说明见 index.md「鉴权说明」(adminToken JWT)。
  • 路径变量 id / domainid 均为企业域 id;telephone 为手机号;systemconfig 路径下的 id 为系统模块 id(如 flowcenter)。

1. 获取域列表

按用户名、域名、自定义扩展字段分页查询企业域列表。超级管理员(isSuperAdmin)可看全部;域管理员仅能看自己所属域。响应中附带分页信息、是否显示「新建」按钮、是否显示「LDAP 同步」按钮、license 类型等前端控制字段。

  • 接口类型:REST 资源
  • 请求方式:POST
  • 请求路径:/domains(完整:{manager-context}/api/authtime/domains)
  • 鉴权:是(需管理员 adminToken,详见 index.md「鉴权说明」)
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
content body JSON 是 过滤条件包体(字段见下)
t_users.id query string 否 按所属用户 id 过滤(超级管理员会被忽略此条件)
currpage query string 否 当前页码,默认 1
pagelines query string 否 每页条数,默认全部域总数

请求体

JSON 对象(application/json):

字段 类型 必填 说明
username string 否 用户名模糊匹配
name string 否 域名模糊匹配
fieldExtends object 否 自定义字段扩展过滤(键值对)

请求示例

POST /api/authtime/domains?currpage=1&pagelines=20 HTTP/1.1
Content-Type: application/json

{
  "username": "admin",
  "name": "默认",
  "fieldExtends": {}
}

响应

结构:统一 Resource(见 ../index.md「统一响应结构」)。 data:JSONObject,字段: - newButtonShow (boolean):是否显示「新建域」按钮 - showLdapButton (boolean):是否显示「LDAP 同步」按钮(仅当认证类型为 SSO + ADUserSSO 时为 true) - licenseType (string):license 类型字符串 - linesPerPage / pageCount / pageNo / rowCount (int):分页信息 - datas (array\<JSONObject>):企业域数组,元素字段: - id / name / status / logoUrl / systemName / abbreviation - users (array):[{ "userid", "username" }] - parents / childs (array):[{ "domainid", "domainname" }] - field1 ~ field20:20 个自定义字段 - secret (string):域 Secret Key - isOpenThM (boolean):是否开启三员管理(读取全局配置 security.mode)

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "newButtonShow": true,
    "showLdapButton": false,
    "licenseType": "S",
    "linesPerPage": 20,
    "pageCount": 1,
    "pageNo": 1,
    "rowCount": 1,
    "datas": [
      {
        "id": "__P1UD2yVWpnFpUedONr",
        "name": "默认域",
        "status": 1,
        "logoUrl": "",
        "systemName": "MyApps",
        "abbreviation": "默认",
        "users": [ { "userid": "__U001", "username": "admin" } ],
        "parents": [],
        "childs": [],
        "field1": "", "field2": "", "secret": "***",
        "isOpenThM": false
      }
    ]
  },
  "errors": null
}
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


2. 获取指定域

按企业域 id 查询单个企业域详情。域不存在时返回 errcode=4001。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/domain/{id}(完整:{manager-context}/api/authtime/domain/{id})
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
id path string 是 企业域 id

请求示例

GET /api/authtime/domain/__P1UD2yVWpnFpUedONr HTTP/1.1

响应

结构:统一 Resource。 data:JSONObject,字段: - id / name / systemName / abbreviation / yunApiKey / description / skinType / logoUrl / status - systemModuleConfigJson (string):系统模块配置的 JSON 文本 - users / parents / childs:同「获取域列表」结构 - field1 ~ field20:自定义字段 - secret (string):域 Secret Key - isOpenThM (boolean):是否开启三员管理

条件 errcode errmsg data
域不存在 4001 企业域不存在 null
成功 0 ok 域详情对象

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "__P1UD2yVWpnFpUedONr",
    "name": "默认域",
    "systemName": "MyApps",
    "abbreviation": "默认",
    "yunApiKey": "***",
    "description": "",
    "skinType": "default",
    "logoUrl": "",
    "status": 1,
    "systemModuleConfigJson": "[{\"id\":\"flowcenter\",\"enable\":true}]",
    "users": [ { "userid": "__U001", "username": "admin" } ],
    "parents": [],
    "childs": [],
    "field1": "",
    "secret": "***",
    "isOpenThM": false
  },
  "errors": null
}
失败示例:
{ "errcode": 4001, "errmsg": "企业域不存在", "data": null, "errors": null }


3. 测试天翎短信平台

按企业域的 yunApiKey 调用天翎短信平台向指定手机号发送一条测试短信(内容固定为「祝您工作愉快」),用于校验云能力 API Key 与短信余额是否可用。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/domain/{domainid}/sms/{telephone}(完整:{manager-context}/api/authtime/domain/{domainid}/sms/{telephone})
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
domainid path string 是 企业域 id(取其 yunApiKey)
telephone path string 是 测试手机号

请求示例

GET /api/authtime/domain/__P1UD2yVWpnFpUedONr/sms/13800138000 HTTP/1.1

响应

结构:统一 Resource。 data:JSONObject,由短信发送结果决定,字段 type 标识失败类别:

条件 errcode errmsg data
成功 0 ok 发送结果对象(由底层 SDK 返回)
API KEY 无效 0 ok { "type": "invalid", "message": "无效的API KEY..." }
短信余额不足 0 ok { "type": "insufficient", "message": "短信剩余数量已不足..." }
其他连接异常 0 ok { "type": "connectionFailed", "message": "connectionFailed" }

注:本端点将各类异常包入 data.type 返回,HTTP 层始终为 200 + errcode=0;仅当方法本身抛出未捕获异常时才由 Spring 默认异常处理(HTTP 500,无统一 Resource 体)。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": { "type": "success", "message": "发送成功" }, "errors": null }
失败示例:
{ "errcode": 0, "errmsg": "ok", "data": { "type": "insufficient", "message": "短信剩余数量已不足" }, "errors": null }


4. 创建企业域

新建一个企业域。会校验域名称合法性、域名称是否已存在;新建成功后自动创建该域的工作日历(CalendarHelper.createCalendarByDomain),并把当前管理员加入该域用户列表。响应 HTTP 状态码为 201。

  • 接口类型:REST 资源
  • 请求方式:POST
  • 请求路径:/domain(完整:{manager-context}/api/authtime/domain)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
content body JSON 是 DomainVO 序列化字段(见下)

请求体

JSON 对象(application/json),关键字段:

字段 类型 必填 说明
name string 是 域名称(空字符串返回 errcode=4001)
systemName string 否 系统名称
abbreviation string 否 简称
description string 否 描述
skinType string 否 皮肤类型
logoUrl string 否 Logo URL
yunApiKey string 否 云能力 API Key
status int 否 状态
parents string 否 父域 id 列表(分号分隔)
field1~field20 string 否 自定义扩展字段

请求示例

POST /api/authtime/domain HTTP/1.1
Content-Type: application/json

{
  "name": "新域",
  "systemName": "MyApps",
  "abbreviation": "新",
  "description": "测试新建"
}

响应

结构:统一 Resource。 data:JSONObject(由 domain2json 输出),字段 id / name / systemName / abbreviation / yunApiKey / description / skinType / logoUrl / status / users。

条件 errcode errmsg data
名称为空 4001 {*[cn.myapps.core.domain.label.name.illegal]*} null
同名域已存在 4001 {*[core.domain.exist]*} null
成功 0 ok 新建域对象(HTTP 201)
抛异常 500 <异常信息> null

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "__NEWDOMAIN01",
    "name": "新域",
    "systemName": "MyApps",
    "abbreviation": "新",
    "yunApiKey": "",
    "description": "测试新建",
    "skinType": null,
    "logoUrl": "",
    "status": 0,
    "users": [ { "userid": "__U001", "username": "admin" } ]
  },
  "errors": null
}
失败示例:
{ "errcode": 4001, "errmsg": "{*[core.domain.exist]*}", "data": null, "errors": null }


5. 更新企业域

更新指定企业域。同步刷新三员管理开关(security.mode 配置),校验域名称合法性 / 唯一性;仅 DomainVO 中的名称、皮肤、状态、描述、API Key、系统名称、简称、Logo、父域、field1 ~ field20 等字段会被持久化。

  • 接口类型:REST 资源
  • 请求方式:PUT
  • 请求路径:/domain/{id}(完整:{manager-context}/api/authtime/domain/{id})
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
id path string 是 企业域 id(路径变量;实际取请求体中 vo.id 做持久化依据)
content body JSON 是 DomainVO 序列化字段(同「创建企业域」)

请求体

同「创建企业域」请求体,但需在体中带上 id 字段,并额外支持:

字段 类型 必填 说明
isOpenThM boolean 否 三员管理开关(写入全局配置 security.mode)

请求示例

PUT /api/authtime/domain/__P1UD2yVWpnFpUedONr HTTP/1.1
Content-Type: application/json

{
  "id": "__P1UD2yVWpnFpUedONr",
  "name": "默认域",
  "systemName": "MyApps",
  "abbreviation": "默认",
  "description": "更新描述",
  "isOpenThM": false
}

响应

结构:统一 Resource。 data:JSONObject(domain2json 输出,结构同「创建企业域」)。

条件 errcode errmsg data
名称为空 4001 {*[cn.myapps.core.domain.label.name.illegal]*} null
同名域已存在(id 不一致) 4001 {*[core.domain.exist]*} null
成功 0 ok 更新后的域对象
抛异常 500 <异常信息> null

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "id": "__P1UD2yVWpnFpUedONr",
    "name": "默认域",
    "systemName": "MyApps",
    "abbreviation": "默认",
    "yunApiKey": "***",
    "description": "更新描述",
    "skinType": null,
    "logoUrl": "",
    "status": 0,
    "users": [ { "userid": "__U001", "username": "admin" } ]
  },
  "errors": null
}
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


6. 删除企业域

按企业域 id 数组批量删除企业域,并同步从 Redis SECRETS 缓存中清除对应域的 Secret Key。

  • 接口类型:REST 资源
  • 请求方式:DELETE
  • 请求路径:/domain(完整:{manager-context}/api/authtime/domain)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
ids body string[] 是 待删除的企业域 id 数组(JSON 字符串数组)

请求体

application/json,字符串数组:

[ "__P1UD2yVWpnFpUedONr", "__OTHERDOMAIN02" ]

请求示例

DELETE /api/authtime/domain HTTP/1.1
Content-Type: application/json

[ "__P1UD2yVWpnFpUedONr" ]

响应

结构:统一 Resource。 data:字符串 "删除成功"。

条件 errcode errmsg data
成功 0 ok 删除成功
校验异常(OBPMValidateException) 500 校验消息文本 null
其他异常 500 <异常信息> null

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "删除成功", "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


7. 移除企业域父子关系

将一个域从另一个域的父/子关系列表中剥离(不删除域本身)。当 belong=parent 时从指定域的父域列表移除 removeId;当 belong=child 时从 removeId 的父域列表中移除指定域。

  • 接口类型:REST 资源
  • 请求方式:DELETE
  • 请求路径:/domain/{id}/relation(完整:{manager-context}/api/authtime/domain/{id}/relation)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
id path string 是 当前操作的企业域 id
content body JSON 是 关系剥离参数

请求体

JSON 对象(application/json):

字段 类型 必填 说明
removeId string 是 待移除关系的对方域 id
belong string 是 关系方向:parent(移除父域)/ child(移除子域)

请求示例

DELETE /api/authtime/domain/__P1UD2yVWpnFpUedONr/relation HTTP/1.1
Content-Type: application/json

{ "removeId": "__OTHERDOMAIN02", "belong": "parent" }

响应

结构:统一 Resource。 data:字符串 "移除成功"。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "移除成功", "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


8. 删除自定义图标

按图标相对路径数组批量删除自定义图标文件。文件须存在且为合法图片格式(png / ico / gif / jpg / jpeg / bmp),否则返回 errcode=4001。

  • 接口类型:REST 资源
  • 请求方式:DELETE
  • 请求路径:/icon(完整:{manager-context}/api/authtime/icon)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
path body string[] 是 待删除图标的相对路径数组(相对存储根目录)

请求体

application/json,字符串数组:

[ "/uploads/lib/icon/custom/logo1.png", "/uploads/lib/icon/custom/logo2.png" ]

请求示例

DELETE /api/authtime/icon HTTP/1.1
Content-Type: application/json

[ "/uploads/lib/icon/custom/logo1.png" ]

响应

结构:统一 Resource。 data:字符串 "删除成功"。

条件 errcode errmsg data
任一图标不存在或非图片 4001 图标不存在 null
成功 0 ok 删除成功

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "删除成功", "errors": null }
失败示例:
{ "errcode": 4001, "errmsg": "图标不存在", "data": null, "errors": null }


9. 是否显示企业微信同步按钮

读取全局配置 IS_SHOW_SYNCHRONIZE_FROM_WEIXIN,决定前端是否显示「从企业微信同步到企业域」按钮。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/weixin/synchronization/show(完整:{manager-context}/api/authtime/weixin/synchronization/show)
  • 鉴权:是
  • Tag:企业域模块

请求参数

无。

请求示例

GET /api/authtime/weixin/synchronization/show HTTP/1.1

响应

结构:统一 Resource。 data:字符串(配置项 IS_SHOW_SYNCHRONIZE_FROM_WEIXIN 的原值,可能为 null / "true" / "false" 等)。

成功示例:

{ "errcode": 0, "errmsg": "success", "data": "true", "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


10. 获取图标库列表

列出图标库目录下的子目录与图片文件,返回每个文件 / 目录的元信息(名称、路径、尺寸、大小、类型)。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/icons(完整:{manager-context}/api/authtime/icons)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
path query string 否 自定义查询目录(相对存储根目录);默认 /uploads/lib/icon

请求示例

GET /api/authtime/icons HTTP/1.1

响应

结构:统一 Resource。 data:Collection<IconLibFile>,元素字段:

字段 类型 说明
name string 文件 / 目录名
path string 相对路径(含 path 前缀)
fileType int 1=图片(IMAGE),2=目录(DIR)
size string 图片尺寸,形如 64 x 64(仅图片)
width int 图片宽度(仅图片)
length string 文件大小,形如 12.34 KB(仅图片)

注:本端点异常时控制器 catch 后直接 return null(不返回统一 Resource),由 Spring 默认序列化为空响应体(HTTP 200,body 为 null)。

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [
    { "name": "custom", "path": "/uploads/lib/icon/custom", "fileType": 2, "size": null, "width": 0, "length": null },
    { "name": "logo.png", "path": "/uploads/lib/icon/logo.png", "fileType": 1, "size": "128 x 128", "width": 128, "length": "5.12 KB" }
  ],
  "errors": null
}
失败示例:
HTTP 200,响应体为 null(异常被吞掉,返回 Java null)


11. 同步 LDAP 部门及用户到企业域

按企业域 id 触发 LDAP 同步,从配置的 LDAP 服务器拉取部门 / 用户信息并写入本地企业域。LDAP 管理员账号 / 密码取自全局配置(LdapConfig.MANAGER / MANAGERPASSWORD)。

  • 接口类型:REST 资源
  • 请求方式:POST
  • 请求路径:/domain/synchldap(完整:{manager-context}/api/authtime/domain/synchldap)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
domainid query string 是 企业域 id

请求示例

POST /api/authtime/domain/synchldap?domainid=__P1UD2yVWpnFpUedONr HTTP/1.1

响应

结构:统一 Resource。 data:字符串资源键 {*[Synchronize.successful]*}(同步成功)。

条件 errcode errmsg data
LDAP 账号/密码未配置(OBPMValidateException) 500 {*[core.domain.LDAPConfig]*} 或 {*[core.domain.configError]*} null
其他异常 500 {*[Synchronize.fail]*} null
关闭 LDAP 上下文时命名异常 500 {*[OBPMRuntimeException]*} null
成功 0 ok {*[Synchronize.successful]*}

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "{*[Synchronize.successful]*}", "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "{*[Synchronize.fail]*}", "data": null, "errors": null }


12. 重置企业域 Secret Key

为指定企业域生成并持久化新的 Secret Key(Sequence.getLongSequence),同步刷新 Redis SECRETS 缓存。

  • 接口类型:REST 资源
  • 请求方式:PUT
  • 请求路径:/domain/{id}/secret(完整:{manager-context}/api/authtime/domain/{id}/secret)
  • 鉴权:是
  • Tag:企业域模块

注:源码 @Operation(summary) 文案为「获取 Secret Key」,实际行为是**重置并返回**新的 Secret Key,按语义描述。

请求参数

参数名 位置 类型 必填 说明
id path string 是 企业域 id

请求示例

PUT /api/authtime/domain/__P1UD2yVWpnFpUedONr/secret HTTP/1.1

响应

结构:统一 Resource。 data:字符串,新生成的 Secret Key。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "12345678901234567890", "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


13. 获取云能力服务列表

按企业域的 yunApiKey 调用云能力中心 GET {YUN_URL}/api/services/list,返回该 API Key 可用的云服务列表。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/domain/{id}/cloudcenter/services(完整:{manager-context}/api/authtime/domain/{id}/cloudcenter/services)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
id path string 是 企业域 id(取其 yunApiKey)

请求示例

GET /api/authtime/domain/__P1UD2yVWpnFpUedONr/cloudcenter/services HTTP/1.1

响应

结构:统一 Resource。 data:JSONObject,字段: - apiKey (string):当前企业域的 yunApiKey - data (JSONArray):云能力中心返回的服务列表(结构由云能力中心决定)

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": {
    "apiKey": "***",
    "data": [
      { "code": "sms", "name": "短信服务", "enable": true }
    ]
  },
  "errors": null
}
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


14. 保存云能力中心 API Key

将请求体中的 apiKey 写入指定企业域的 yunApiKey 字段并持久化。

  • 接口类型:REST 资源
  • 请求方式:POST
  • 请求路径:/domain/{id}/cloudcenter/user(完整:{manager-context}/api/authtime/domain/{id}/cloudcenter/user)
  • 鉴权:是
  • Tag:企业域模块

注:源码 @Operation(summary) 文案为「保存云能力中心API Key」(方法名 saveYunProfile),按语义描述。

请求参数

参数名 位置 类型 必填 说明
id path string 是 企业域 id
json body JSON 是 待保存的 API Key 包体

请求体

JSON 对象(application/json):

字段 类型 必填 说明
apiKey string 是 云能力中心 API Key

请求示例

POST /api/authtime/domain/__P1UD2yVWpnFpUedONr/cloudcenter/user HTTP/1.1
Content-Type: application/json

{ "apiKey": "new-api-key-value" }

响应

结构:统一 Resource。 data:null。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


15. 验证云能力中心 API Key

将请求体原样转发给云能力中心 POST {YUN_URL}/service/verify/api-key,验证 apiKey 是否有效。验证结果以字符串形式回传。

  • 接口类型:REST 资源
  • 请求方式:POST
  • 请求路径:/verify/yun-api-key(完整:{manager-context}/api/authtime/verify/yun-api-key)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
body body JSON 是 待验证的 API Key 包体

请求体

JSON 对象(application/json):

字段 类型 必填 说明
apiKey string 是 待验证的云能力中心 API Key

请求示例

POST /api/authtime/verify/yun-api-key HTTP/1.1
Content-Type: application/json

{ "apiKey": "to-be-verified-key" }

响应

结构:统一 Resource。 data:字符串,云能力中心返回的原始响应文本。

条件 errcode errmsg data
apiKey 为空 4001 apiKey不能为空 null
成功 0 ok 云能力中心响应字符串
抛异常 500 <异常信息> null

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": "{\"valid\":true}", "errors": null }
失败示例:
{ "errcode": 4001, "errmsg": "apiKey不能为空", "data": null, "errors": null }


16. 获取基础功能配置

读取指定企业域的系统模块配置(systemModuleConfigs),过滤掉空 id 项;若配置为空则自动初始化一条默认「流程中心」(flowcenter,启用)并持久化。

  • 接口类型:REST 资源
  • 请求方式:GET
  • 请求路径:/domain/{domainid}/systemconfig(完整:{manager-context}/api/authtime/domain/{domainid}/systemconfig)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
domainid path string 是 企业域 id

请求示例

GET /api/authtime/domain/__P1UD2yVWpnFpUedONr/systemconfig HTTP/1.1

响应

结构:统一 Resource。 data:List<SystemModuleConfig>,元素字段:

字段 类型 说明
id string 模块 id(如 flowcenter)
enable boolean 是否启用

成功示例:

{
  "errcode": 0,
  "errmsg": "ok",
  "data": [ { "id": "flowcenter", "enable": true } ],
  "errors": null
}
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


17. 启用基础功能

将指定企业域下某个系统模块标记为启用。若该模块不存在则新增一条已启用记录。

  • 接口类型:REST 资源
  • 请求方式:PUT
  • 请求路径:/domain/{domainid}/systemconfig/{id}/enable(完整:{manager-context}/api/authtime/domain/{domainid}/systemconfig/{id}/enable)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
domainid path string 是 企业域 id
id path string 是 系统模块 id(如 flowcenter)

请求示例

PUT /api/authtime/domain/__P1UD2yVWpnFpUedONr/systemconfig/flowcenter/enable HTTP/1.1

响应

结构:统一 Resource。 data:null。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }


18. 禁用基础功能

将指定企业域下某个系统模块标记为禁用。

  • 接口类型:REST 资源
  • 请求方式:PUT
  • 请求路径:/domain/{domainid}/systemconfig/{id}/disable(完整:{manager-context}/api/authtime/domain/{domainid}/systemconfig/{id}/disable)
  • 鉴权:是
  • Tag:企业域模块

请求参数

参数名 位置 类型 必填 说明
domainid path string 是 企业域 id
id path string 是 系统模块 id(如 flowcenter)

请求示例

PUT /api/authtime/domain/__P1UD2yVWpnFpUedONr/systemconfig/flowcenter/disable HTTP/1.1

响应

结构:统一 Resource。 data:null。

成功示例:

{ "errcode": 0, "errmsg": "ok", "data": null, "errors": null }
失败示例:
{ "errcode": 500, "errmsg": "<异常信息>", "data": null, "errors": null }