自定义IT控制台¶

最后更新：2022-08-19

1. 什么是自定义IT控制台¶

自定义IT控制台面向IDaaS的ISV或者企业用户，依赖IDaaS对外提供的企业IT管理员操作相关API，能够自行灵活的开发自己的控制台界面，因此自定义IT控制台包括了IDaaS管理员常见操作相关的API集合。

2. 控制台API概览¶

模块	子功能
用户认证	登录接口注册接口密码修改查询登录用户信息查询登录用户详细信息登出接口
应用管理	创建应用(jwt,oauth2) 修改应用(jwt,oauth2) 下线应用上线应用应用列表删除应用
用户目录	新建组织机构修改组织机构删除组织机构查询单个组织机构查询根组织机构查询组织下一级组织机构查询某组织下组织机构列表查询组织下直属账户列表新建组修改组删除组查询单个组查询组列表组添加成员组移除成员组成员查询账户列表新建账户修改账户删除账户查询单个账户
授权	应用授权账户应用授权组织
审计	查询操作日志

2.1. 用户认证¶

2.1.1. 登录接口¶

2.1.1.1. 前端登录时预加载一些信息(如是否显示验证码)¶

Path： /api/public/bff/v1.2/pre_frontend_login
Method： GET
接口描述： 当showCaptcha参数为true时，需要调用获取图片验证码接口
请求参数： 无
返回数据：

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	string	非必须
requestId	string	非必须
data	object	非必须
├─ showCaptcha	boolean	非必须	true显示验证码
├─ enableTAC	boolean	非必须	是否开启TAC功能
├─ tacService	string	非必须	TAC服务类型,当前只有BXY(北信源)
├─ tacAgentAddress	string	非必须	TAC服务的Agent下载地址，空则未填写
├─ lockTime	int	非必须	租户锁定时间:分钟
├─ autoLogin	boolean	非必须	是否打开自动登录

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1633776685900$ebf26837-512f-9696-f851-95ffa6103290",
  "data": {
    "logoutUrl": null,
    "tacService": "BXY",
    "enableTAC": false,
    "tacAgentAddress": null,
    "showCaptcha": false,
    "lockTime": 240,
    "autoLogin": false
  }
}

2.1.1.2. 获取图片验证码¶

Path： /api/public/bff/v1.2/one_time_login/captcha
Method： GET
接口描述： 获取图片验证码
请求参数：
Query

参数名称	是否必须	示例	备注
timestamp	否		时间值，可随机生成，保证请求无缓存

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ code	string	必须	验证码code
├─ captcha	string	必须	验证码图片，base64格式数据

返回数据示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "1725846847436$ee73667a-bcf0-259d-dfe3-ea87c2f1bfdf",
    "data": {
        "captcha": "iVBORw0KGgoAAAANSUhEUgAAAFAAAAAaCAIAAACvsEzwAAABKElEQVR42u3XSw7CIBAGYK7gBTyFiasu7DW8A4dxqYfVJiSEMMM/tMOj2DbENKNl+MpT8z3YZU7wCT4s+Ha/gJJ66vF6+gIqn97XsIwKDrXAHGlZ8/yZlkIjbLD8kGaR1lqqjSJACyKjgkH3im+BYigYa13zaoE12tRXlOc/dwTGE3gz2N+zwW5gcdESwWGdSrBrYXUwiKwFs05W3g3M7lJrhzTt5CUS3QwDzlylfc2pjg1fgbtagDEPT2NxH3aG0Akmc6N9WDxmaU5akRlvyH3Axc/SPcGVLkfCnfxXYGqmbPeD1LKUOucWAIsp9TWD/4k52dnleo9gTQeKbBV4FHPYWqNsU1Vz8SG2/eARrR9d2NuSmlIp25tpxpw2mIIpG5vZdD6YaswPLke7ounYfBUAAAAASUVORK5CYII=",
        "code": "2858b08cf6ea82c5af61a67f27b01455lW6TEJ3tZmG"
    }
}

2.1.1.3. 获取SM2的公钥与code¶

Path： /api/public/bff/v1.2/sm2_key
Method： POST
接口描述： 该接口用于获取密码传输时进行sm2加密的公钥。开放接口，无需token校验。该接口无需传参
请求参数： 无
返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ code	string	必须	sm2_code，登录时需要传该参数
├─ publicKey	string	必须	公钥，密码用该公钥进行加密

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1633776686006$ebe5e4f0-f416-44a0-f5cf-86b1824a19cd",
  "data": {
    "code": "cf6039c2b435d08ed4cee7c5f42ff5d1FGBPnYUdFkr",
    "publicKey": "BIWp9RKMUorhbUNlhq+fCDequRV/dVx4auOJlWN5Y/GFhwX0zgC0fuWhbuiS1GpmOq+behq4wHvqN4NvGmPHKdw="
  }
}

2.1.1.4. 前端登录,REST¶

Path： /api/public/bff/v1.2/rest_token
Method： POST
接口描述： 前端登录API
错误码列表:

HttpCode	错误码	错误信息	描述
400	invalid_captcha	invalid_captcha	验证码错误
401	invalid_token	Invalid access token: xxx	无效的access_token

请求参数
Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注
cap_code	string	非必须		验证码code
cap_text	sring	非必须		验证码输入内容
client_id	string	必须
grant_type	string	必须	password
scope	string	非必须
username	string	必须
password	string	必须		密码先使用sm2加密，再使用base64加密
sm2_code	string	非必须		通过接口3获取
_enterprise_id	string	非必须		租户id

返回数据

名称	类型	是否必须
success	boolean	必须
code	string	必须
message	string	必须
requestId	string	必须
data	object	必须
├─ access_token	string	必须
├─ token_type	string	必须
├─ expires_in	string	必须
├─ refresh_token	string	必须

返回数据示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "1633777399677$b716a698-a055-ceeb-f919-a95e699f7e14",
    "data": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6...",
        "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX...",
        "token_type": "bearer",
        "expires_in": 43199
    }
}

2.1.1.5. 接口使用注意事项¶

（如接口2必须在接口1完成的前提下，才能根据获取到的值，进行接口2的调用；也可以是其他说明）
在登录时，先调用接口1，获取是否需要使用图片验证码，若是则需要调用接口2；再调用接口3获取sm2_code和publicKey，在调用登录接口4进行登录的时候，使用该公钥，先进行sm2加密，再进行base64加密，加密后的密文作为参数进行传输。

2.1.2. 注册接口¶

说明：注册功能默认是关闭的，需要先开启才能使用，具体在IT管理员登录后，设置->安全设置->注册/登录/登出中开启‘允许注册’。

基本信息

Path： /api/public/bff/v1.2/register

Method： POST

接口描述：

认证源统一API, 注册账户

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
captchaCode	string	必须	验证码code	mock: 92938928fsoowfs
captcha	string	必须	验证码	mock: 764587
username	string	必须	账户名,唯一	mock: goaoes
email	string	必须	账户邮箱	mock: goaoes@test.com
phoneNumber	string	必须	手机号	mock: 13343434343
password	string	必须	账户密码	mock: Jzyt@2019_
clientToken	string	必须	处理幂等	mock: 3fawqe1rff31fssafsa
clientId	string	必须	OAuth2 clientId
enterpriseId	string	必须	租户id
sm2_code	string	非必须	密码SM2加密code

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	必须	请求是否成功
code	string	必须	状态码, 200为成功
message	string	必须	状态信息
data	object	必须	响应的数据对象
├─ access_token	string	必须
├─ token_type	string	必须		mock: bearer
├─ refresh_token	string	必须
├─ expires_in	number	必须	access_token有效时间, 单位:秒
├─ scope	string	必须		mock: read

2.1.3. 密码修改¶

基本信息

Path： /api/bff/v1.2/enduser/portal/user_info/modify_password

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
oldPassword	string	必须
newPassword	string	必须
confirmPassword	string	必须
invalidateSession	boolean	非必须	true表示要清除session，默认false

返回数据

名称	类型	是否必须	默认值	备注
success	boolean	必须
code	string	必须
message	string	必须
requestId	string	必须
data	object	必须
├─ systemUserUuid	string	必须
├─ storePassword	boolean	必须	false	是否存储密码

2.1.4. 查询登录用户信息¶

基本信息

Path： /api/bff/v1.2/commons/user_details

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization	Bearer {access_token}	是

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ enterpriseInformation	object	非必须	公司信息
├── uuid	string	非必须	公司uuid
├── fullName	string	非必须	公司名称
├── enterpriseId	string	非必须	公司id
├── enterpriseHost	string	非必须	公司host
├─ udAccountInformation	object	非必须	登录用户信息
├── userUuid	string	非必须	用户uuid
├── username	string	非必须	用户名称
├── externalId	string	非必须	外部ID
├── firstLogin	boolean	非必须	是否首次登录
├─ defaultPSSystemUuid	string	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1634180486849$b781d57b-8c2a-2381-1cfd-31f8ba624a33",
  "data": {
    "enterpriseInformation": {
      "enterpriseId": "sz",
      "fullName": "SZ",
      "enterpriseHost": "https://{IDaaS_server}/",
      "uuid": "e24afba4c9baf4ce6db5d661b1027be46tKvzFWN3Uz"
    },
    "udAccountInformation": {
      "firstLogin": false,
      "displayName": "默认管理员",
      "userUuid": "ff0bb0ba58b32c8c0aa55681ace3d7ffUXstjsnInAp",
      "externalId": "6639422426993669394",
      "username": "admin"
    },
    "defaultPSSystemUuid": "915a723d4b58131b96427ca5a23c6378tZzHUWOrLcn"
  }
}

2.1.5. 查询登录用户详细信息¶

基本信息

Path： /api/bff/v1.2/user/detail

Method： GET

接口描述：

账户详情,包含基本信息、证书信息、认证源信息等

请求参数

Query

参数名称	是否必须	示例	备注
userUuid	是	8ac700bb4a4063bd4d07b99cf54a2258R3e6uMGk6bd	用户uuid
access_token	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ basicInformation	object	非必须	基础信息
├─ userUuid	string	非必须	用户uuid
├─ createTime	number	非必须	创建时间
├─ username	string	非必须	用户名称
├─ email	string	非必须	邮箱
├─ phoneNumber	null	非必须	手机号码
├─ description	string	非必须	描述
├─ userId	string	非必须	用户id
├─ user2factor	boolean	非必须	二次认证
├─ locked	boolean	非必须	是否锁定
├─ admin	boolean	非必须	是否是超管
├─ ouDirectory	string	非必须	主目录路径
├─ udAccountType	string	非必须	账户类型
├─ displayName	string	非必须	显示名称
├─ expired	boolean	非必须	是否过期
├─ expireDate	string	非必须	过期时间
├─ logoUuid	null	非必须
├─ externalId	string	非必须	外部id
├─ realNameFlag	boolean	非必须	是否实名认证
├─ idCard	null	非必须	身份证号
├─ realName	null	非必须	姓名
├─ enabled	boolean	非必须	是否启用
├─ phoneRegion	string	非必须	手机号区域
├─ dictionaryList	object []	非必须	数据字典	item 类型: object
├── dictionaryUuid	string	非必须	数据字典uuid
├── fieldName	string	非必须	数据字典key
├── fieldType	string	非必须	数据字典类型（文本输入框-TEXT，文本域-MULTI_TEXT，下拉框-SELECT，日期-DATE_OF_YYYY_MM_DD）
├── selectFieldOptions	object[]	非必须	下拉框时，有具体下拉框值，详细看以下返回数据示例
├─ dictionaryValues	object []	非必须	账户对应数据字典值	item 类型: object
├── dictionaryUuid	string	非必须	数据字典uuid
├── dictionaryValueTransientValue	string	非必须	数据字典值
├─ certificate	null	非必须
├─ boundAuthentications	object[]	非必须		item 类型: object
├─		非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1634180741532$1072e147-5a93-49e0-00db-9bc9acd63ef8",
  "data": {
    "basicInformation": {
      "userUuid": "23de772f0bf244e29a9dc390acd87a62RvFwWpTc2hr",
      "createTime": 1629773460000,
      "username": "test999",
      "email": "test999@idaas.net",
      "phoneNumber": null,
      "description": "",
      "userId": "7776456025788959541",
      "user2factor": false,
      "locked": false,
      "admin": false,
      "ouDirectory": "/SES/",
      "udAccountType": "SELF_ACCOUNT",
      "displayName": "test999",
      "expired": false,
      "expireDate": "2116-12-31",
      "logoUuid": null,
      "externalId": "7776456025788959541",
      "realNameFlag": false,
      "idCard": null,
      "realName": null,
      "enabled": true,
      "phoneRegion": "86",
      "dictionaryList": [
        {
          "dictionaryUuid": "c6d19e3fd4e165b09a9aa3fc8ddfe15cC6EOEWVkqq1",
          "fieldName": "默认值唯一测试",
          "fieldType": "MULTI_TEXT",
          "selectFieldOptions": [
            {
              "optionId": "4cc9f9fbed0b2ebd1d9c79854ea90ab0gLnSD8XbkET",
              "optionLabel": "高分",
              "optionValue": ">90",
              "enabled": true,
              "add": false
            },
            {
              "optionId": "4cc9f9fbed0b2ebd1d9c79854ea90ab0gLnSD8XbkET",
              "optionLabel": "低分",
              "optionValue": "<60",
              "enabled": true,
              "add": false
            }
          ]
        }
      ],
      "dictionaryValues": [
        {
          "dictionaryUuid": "c6d19e3fd4e165b09a9aa3fc8ddfe15cC6EOEWVkqq1",
          "dictionaryValueTransientValue": ">90"
        }
      ]
    },
    "certificate": null,
    "boundAuthentications": []
  }
}

2.1.6. 登出接口¶

基本信息

Path： /api/bff/v1.2/commons/logout

Method： POST

接口描述：

前端退出

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization	Bearer {access_token}	是

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ logout	boolean	非必须	是否已登出
├─ spLogoutUrls	string []	非必须	SP退出地址URL	item 类型: string

2.2. 登录后令牌上传说明¶

除登录、注册等没有特殊说明不需要token的接口外，其余接口都需要在请求header中传入登录返回的access_token鉴权
请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization	Bearer {access_token}	是

2.3. 应用管理¶

2.3.1. 新建JWT应用¶

2.3.1.1. 新建JWT-加载schema¶

schema是一组JSON数据，用于前端渲染表单使用。

基本信息
Path： /api/bff/v1.2/application/plugin_jwt/schema

Method： GET
请求参数

Query

参数名称	是否必须	示例	备注
applicationId	否	plugin_jwt
type	是	plus	标识加载的scheam是添加(plus)，修改(modify)或详细(details)

返回数据

名称	类型	是否必须
success	boolean	必须
code	string	必须
message	string	必须
data	object	必须
├─ schemas	string	必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "schemas": "{\"explain\":{\"zh\":\"JWT应用使用长度为2048的RS256加密算法。\",\"en\":\"JWT applications use the RS256 encryption algorithm with 2048-bit keys.\"},\"formData\":[{\"key\":\"instanceId\",\"name\":{\"zh\":\"enterpriseId\",\"en\":\"enterpriseId\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"uuid\",\"name\":{\"zh\":\"uuid\",\"en\":\"uuid\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"logoUuid\",\"name\":{\"zh\":\"应用图标\",\"en\":\"Application Logo\"},\"type\":\"file\",\"show\":true,\"send\":true},{\"key\":\"purchaseId\",\"name\":{\"zh\":\"应用ID\",\"en\":\"Application ID\"},\"type\":\"input\",\"readonly\":true,\"show\":true,\"send\":true},{\"key\":\"name\",\"name\":{\"zh\":\"应用名称\",\"en\":\"Application Name\"},\"type\":\"input\",\"readonly\":false,\"placeholder\":{\"zh\":\"请填写应用名称\",\"en\":\"Please enter the Name\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"deviceTypes\",\"name\":{\"zh\":\"应用类型\",\"en\":\"Application Type\"},\"type\":\"checkbox\",\"options\":[{\"label\":\"WEB\",\"value\":{\"zh\":\"Web应用\",\"en\":\"Web Application\"},\"disabled\":false},{\"label\":\"MOBILE\",\"value\":{\"zh\":\"移动应用\",\"en\":\"Moblie Application\"},\"disabled\":false},{\"label\":\"PC\",\"value\":{\"zh\":\"PC客户端\",\"en\":\"PC\"},\"disabled\":false}],\"description\":{\"zh\":\"“Web应用”和“PC客户端”只会在用户Web使用环境中显示，“移动应用”只会在用户客户端中显示，如果想在多个环境中都显示应用则勾选多个。\",\"en\":\"'Web app' and 'PC client' will only be displayed in the user's web using environment, and 'mobile app' will only be displayed in the user's client. If you want to display apps in multiple environments, check multiple.\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"change\",\"type\":\"array\"},\"show\":true,\"send\":true},{\"key\":\"field\",\"name\":{\"zh\":\"field\",\"en\":\"field\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"loginUrl\",\"name\":{\"zh\":\"redirect_uri\",\"en\":\"redirect_uri\"},\"type\":\"textarea\",\"readonly\":false,\"placeholder\":{\"zh\":\"应用单点登录地址，如：http://www.xxx.com/sso/parse，多个请换行。\",\"en\":\"Enter the application SSO URL. For example, http://www.xxx.com/sso/parse, There are more than one, Please enter a newline.\"},\"description\":{\"zh\":\"业务系统中的 JWT 单点登录地址，单点登录时 IDaaS 会携带 id_token 重定向至该地址，应用系统校验 id_token 获取用户身份以完成登录。支持输入多条地址，地址之间以请以换行分隔，在业务系统（SP）发起单点登录时，SP可以携带 redirect_uri 参数以指定单点登录地址，指定的地址必须完全匹配列表中的一条地址，否则 IDaaS 会拒绝跳转，在 IDaaS 发起单点登录，或者SP发起单点登录是未携带 redirect_uri 时，将默认选择该列表中的第一条地址。\",\"en\":\"The URL is used by the service provider to receive SSO parameters. In an SSO, IDaaS sends the id_token parameter to this URL in a GET request, Get user identity to complete login, Support to enter multiple addresses, When the service system (SP) initiates single sign on, SP can carry redirect_ uri parameter to specify the single sign on address. The specified address must exactly match an address in the list, otherwise idaas will refuse to SP, Single sign on initiated in IDaaS or SP does not carry redirect_uri, the first address in the list is selected by default.\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"redirectUrl\",\"name\":{\"zh\":\"target_url\",\"en\":\"target_url\"},\"type\":\"input\",\"readonly\":false,\"placeholder\":{\"zh\":\"单点登录后的跳转地址，如：http://www.xxx.com/service/message\",\"en\":\"The URL that users will be directed to after logon. For example, http://www.xxx.com/service/message.\"},\"description\":{\"zh\":\"单点登录成功后，会在 IDaaS 跳转到 redirect_uri 时和id_token同时携带，一般用于跳转到deeplinking的二级菜单、指定页面等，此项可选。\",\"en\":\"Optional, After successful single sign on, it will jump to redirect in idaas_ Uri time and ID_ Token is carried at the same time. It is generally used to jump to the secondary menu of deep linking and the specified page.\"},\"rules\":{\"required\":false,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"binding\",\"name\":{\"zh\":\"SSO Binding\",\"en\":\"SSO Binding\"},\"type\":\"select\",\"options\":[{\"label\":\"POST\",\"value\":{\"zh\":\"POST\",\"en\":\"POST\"},\"disabled\":false},{\"label\":\"REDIRECT\",\"value\":{\"zh\":\"REDIRECT\",\"en\":\"REDIRECT\"},\"disabled\":false}],\"disabled\":false,\"description\":{\"zh\":\"单点登录请求方式，REDIRECT为GET类型\",\"en\":\"Single sign on request mode, redirect is get type\"},\"rules\":{\"required\":false,\"message\":\"此项不能为空\",\"trigger\":\"change\"},\"show\":true,\"send\":true},{\"key\":\"idTokenExpiration\",\"name\":{\"zh\":\"ID_Token有效期\",\"en\":\"ID_Token Validity\"},\"type\":\"number\",\"disabled\":false,\"readonly\":false,\"number\":{\"max\":86400,\"min\":1,\"formatter\":\"\",\"parser\":\"\"},\"description\":{\"zh\":\"ID_Token的有效期，单位为：秒\",\"en\":\"The validity period of id_token. Unit: seconds.\"},\"show\":true,\"send\":true},{\"key\":\"display\",\"name\":{\"zh\":\"是否显示应用\",\"en\":\"Display Application\"},\"type\":\"switch\",\"disabled\":false,\"description\":{\"zh\":\"授权给用户后，是否在用户首页显示。\",\"en\":\"Whether to display the application on the user homepage after a user is authorized to access the application.\"},\"rules\":{\"required\":false,\"message\":\"此项不能为空\",\"trigger\":\"change\",\"type\":\"boolean\"},\"show\":true,\"send\":true},{\"key\":\"supportSPLogout\",\"name\":{\"zh\":\"SP支持退出\",\"en\":\"Support SP Logout\"},\"type\":\"switch\",\"disabled\":false,\"description\":{\"zh\":\"若应用支持退出，请勾选上并填写'SP退出地址'\",\"en\":\"If SP support logout, please check it and type SP-Logout-URL\"},\"rules\":{\"required\":false,\"message\":\"此项不能为空\",\"trigger\":\"change\",\"type\":\"boolean\"},\"show\":true,\"send\":true},{\"key\":\"spLogoutUrl\",\"name\":{\"zh\":\"SP退出地址\",\"en\":\"SP Logout URL\"},\"type\":\"input\",\"readonly\":false,\"placeholder\":{\"zh\":\"https://...\",\"en\":\"https://...\"},\"description\":{\"zh\":\"应用提供由IDP调用的退出地址；当全局退出时，会调用此地址退出此应用\",\"en\":\"SP support logout URL, call by IDP\"},\"rules\":{\"required\":false,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"accountLinkingTemplateUuid\",\"type\":\"accountlinking\",\"show\":true,\"send\":true}]}"
  }
}

2.3.1.2. 新建JWT-加载信息¶

基本信息
Path： /api/bff/v1.2/application/plugin_jwt/plus

Method： GET
请求参数

Query

参数名称	是否必须	示例	备注
applicationId	否	plugin_jwt
enterpriseId	否	idaas	租户id

返回数据

名称	类型	是否必须
success	boolean	必须
code	string	必须
message	string	必须
data	object	必须
├─ applicationJson	string	必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "applicationJson": "{\"accountLinkingTemplateUuid\":\"\",\"accountLinkingTemplates\":[{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"defaultLinking\":false,\"description\":\"系统按主子账户对应关系进行手动关联，用户添加后需要管理员审批\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"Bh4xdy2lfQPP\",\"templateName\":\"账户关联\",\"templateType\":\"账户关联\",\"templateTypeCode\":\"USERNAME\",\"uuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\"},{\"accountLinkingTemplateUuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\",\"defaultLinking\":true,\"description\":\"系统自动将主账户名称或指定的字段映射为应用的子账户\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"dKr75J08JxDY\",\"templateName\":\"账户映射\",\"templateType\":\"账户映射\",\"templateTypeCode\":\"USER_MAPPING\",\"uuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\"}],\"allSpLoginTypes\":[\"APPLICATION\",\"IDP\"],\"allowAppList\":false,\"allowUserAccessToken\":false,\"allowUserPrivileges\":false,\"applicationId\":\"plugin_jwt\",\"authScope\":\"AUTHORIZED\",\"availableFields\":[\"PRIVATE_CLOUD\",\"PUBLIC_CLOUD\",\"MOBILE\",\"IOT\",\"NETWORK\",\"OTHER\"],\"binding\":\"REDIRECT\",\"clientToken\":\"\",\"deviceTypes\":[\"WEB\"],\"display\":true,\"enterpriseId\":\"sz\",\"field\":null,\"idTokenExpiration\":600,\"loginUrl\":\"\",\"logoUrl\":\"\",\"logoUuid\":\"\",\"name\":\"JWT\",\"purchaseId\":\"szplugin_jwt4\",\"redirectUrl\":\"\",\"spLoginType\":\"IDP\",\"spLogoutUrl\":\"\",\"supportSPLogout\":false}"
  }
}

2.3.1.3. 新建JWT-提交表单¶

基本信息

Path： /api/bff/v1.2/application/plugin_jwt/plus

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须
enterpriseId	string	必须
applicationId	string	非必须
applicationJson	string	必须
clientToken	string	非必须

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ applicationUuid	string	必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "applicationUuid": "b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM"
  }
}

2.3.2. 新建OAuth2应用¶

2.3.2.1. 新建OAuth2-加载schema¶

schema是一组JSON数据，用于前端渲染表单使用。

基本信息
Path： /api/bff/v1.2/application/plugin_oauth2/schema

Method： GET
请求参数

Query

参数名称	是否必须	示例	备注
applicationId	是	plugin_jwt
type	是	plus	标识加载的scheam是添加(plus)，修改(modify)或详细(details)

返回数据

名称	类型	是否必须
success	boolean	必须
code	string	必须
message	string	必须
data	object	必须
├─ schemas	string	必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "schemas": "{\"explain\":{\"zh\":\"OAuth2 应用只实现了 SP(Server Provider, 业务系统方) 发起的单点登录流程。\",\"en\":\"Applications that use OAuth 2.0 only support SP-initiated SSO and therefore are not displayed on the user logon page.\"},\"formData\":[{\"key\":\"instanceId\",\"name\":{\"zh\":\"enterpriseId\",\"en\":\"enterpriseId\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"uuid\",\"name\":{\"zh\":\"uuid\",\"en\":\"uuid\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"logoUuid\",\"name\":{\"zh\":\"应用图标\",\"en\":\"Application Logo\"},\"type\":\"file\",\"show\":true,\"send\":true},{\"key\":\"purchaseId\",\"name\":{\"zh\":\"应用ID\",\"en\":\"Application ID\"},\"type\":\"input\",\"readonly\":true,\"show\":true,\"send\":true},{\"key\":\"name\",\"name\":{\"zh\":\"应用名称\",\"en\":\"Application Name\"},\"type\":\"input\",\"readonly\":false,\"placeholder\":{\"zh\":\"请填写应用名称\",\"en\":\"Please enter the Name\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"deviceTypes\",\"name\":{\"zh\":\"应用类型\",\"en\":\"Application Type\"},\"type\":\"checkbox\",\"options\":[{\"label\":\"WEB\",\"value\":{\"zh\":\"Web应用\",\"en\":\"Web Application\"},\"disabled\":false},{\"label\":\"MOBILE\",\"value\":{\"zh\":\"移动应用\",\"en\":\"Moblie Application\"},\"disabled\":false},{\"label\":\"PC\",\"value\":{\"zh\":\"PC客户端\",\"en\":\"\"},\"disabled\":false}],\"description\":{\"zh\":\"“Web应用”和“PC客户端”只会在用户Web使用环境中显示，“移动应用”只会在用户客户端中显示，如果想在多个环境中都显示应用则勾选多个。\",\"en\":\"\\\"Mobile app\\\" will only be displayed in the user client,If you want to display apps in multiple environments, check multiple apps.\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"change\",\"type\":\"array\"},\"show\":true,\"send\":true},{\"key\":\"field\",\"name\":{\"zh\":\"field\",\"en\":\"field\"},\"type\":\"input\",\"show\":false,\"send\":true},{\"key\":\"webServerRedirectUri\",\"name\":{\"zh\":\"Redirect URI\",\"en\":\"Redirect URI\"},\"type\":\"textarea\",\"readonly\":false,\"placeholder\":{\"zh\":\"请输入Redirect URI\",\"en\":\"Enter the Redirect URI\"},\"description\":{\"zh\":\"OAuth2 Redirect URI, 请以 http 或 https 开头.\",\"en\":\"OAuth2 Redirect URI, Please start with HTTP or HTTPS.\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"blur\"},\"show\":true,\"send\":true},{\"key\":\"authorizedGrantTypes\",\"name\":{\"zh\":\"GrantType\",\"en\":\"GrantType\"},\"type\":\"select\",\"options\":[{\"label\":\"implicit\",\"value\":{\"zh\":\"implicit\",\"en\":\"implicit\"},\"disabled\":false},{\"label\":\"authorization_code\",\"value\":{\"zh\":\"authorization_code\",\"en\":\"authorization_code\"},\"disabled\":false},{\"label\":\"PKCE\",\"value\":{\"zh\":\"PKCE\",\"en\":\"PKCE\"},\"disabled\":false}],\"disabled\":false,\"description\":{\"zh\":\"Authorization_Code：授权码模式（即先登录获取Code,再获取Token），标准OAuth2流程；Implicit：简化模式（在Redirect_uri的Hash传递Token）适用于验证第三方合法性时使用；PKCE:属于授权码模式的一个扩展，主要适用于无后端服务器来接收和处理Authorization Code授权码的应用。应用决定加密方式并生成密文，IDP通过校验密文的合法性来判断应用的身份，以此来增强应用端和IDP之间的校验，防止通信劫持。\",\"en\":\"authorization_code: authorization code mode (log on to obtain the code and then obtain the token), standard OAuth2 process; implicit: simplified mode (in the redirect_uri Hash delivery token) is used to verify the legality of third parties;PKCE: an extension of authorization code mode, which is mainly applicable to applications without back-end server to receive and process authorization code. The application determines the encryption method and generates ciphertext. IDP judges the identity of the application by verifying the legality of the ciphertext, so as to enhance the verification between the application end and IDP and prevent communication hijacking.\"},\"rules\":{\"required\":true,\"message\":\"此项不能为空\",\"trigger\":\"change\"},\"show\":true,\"send\":true},{\"key\":\"accessTokenValidity\",\"name\":{\"zh\":\"Access_Token有效期\",\"en\":\"Access_Token Validity\"},\"type\":\"number\",\"disabled\":false,\"readonly\":false,\"number\":{\"max\":86400,\"min\":1,\"formatter\":\"\",\"parser\":\"\"},\"description\":{\"zh\":\"Access_Token的有效时长(单位: 秒)，默认为7200(2小时)\",\"en\":\"The validity period of Access_Token. Unit: seconds. Default is 7,200.\"},\"show\":true,\"send\":true},{\"key\":\"refreshTokenValidity\",\"name\":{\"zh\":\"Refresh Token有效期\",\"en\":\"Refresh Token Validity\"},\"type\":\"number\",\"disabled\":false,\"readonly\":false,\"number\":{\"max\":2592000,\"min\":1,\"formatter\":\"\",\"parser\":\"\"},\"description\":{\"zh\":\"Refresh Token的有效时长(单位: 秒)，默认为604800(7天)\",\"en\":\"The validity period of Refresh Token. Unit: seconds. Default is 604,800.\"},\"show\":true,\"send\":true},{\"key\":\"authorizeCodeValidity\",\"name\":{\"zh\":\"授权码CODE有效期\",\"en\":\"authorizeCode Validity\"},\"type\":\"number\",\"disabled\":false,\"readonly\":false,\"number\":{\"max\":86400,\"min\":1,\"formatter\":\"\",\"parser\":\"\"},\"description\":{\"zh\":\"授权码CODE的有效时长(单位: 秒)，默认为60(1分钟)\",\"en\":\"The validity period of authorizeCode Validity. Unit: seconds. Default is 60.\"},\"show\":true,\"send\":true}]}"
  }
}

2.3.2.2. 新建OAuth2-加载信息¶

基本信息
Path： /api/bff/v1.2/application/plugin_oauth2/plus

Method： GET
请求参数

Query

参数名称	是否必须	示例	备注
applicationId	是	plugin_jwt
enterpriseId	是	idaas	租户id

返回数据

名称	类型	是否必须
success	boolean	必须
code	string	必须
message	string	必须
data	object	必须
├─ applicationJson	string	必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "applicationJson": "{\"accessTokenValidity\":7200,\"appKey\":\"\",\"appSecret\":\"\",\"applicationId\":\"plugin_oauth2\",\"authorities\":\"\",\"authorizeCodeValidity\":60,\"authorizeUrl\":\"\",\"authorizedGrantTypes\":\"\",\"availableFields\":[\"PRIVATE_CLOUD\",\"PUBLIC_CLOUD\",\"MOBILE\",\"IOT\",\"NETWORK\",\"OTHER\"],\"createTime\":\"\",\"creator\":\"\",\"deviceTypes\":[\"WEB\"],\"enabled\":false,\"enterpriseId\":\"sz\",\"field\":null,\"homepageUrl\":\"\",\"idpApplicationId\":\"\",\"idpSLOAddress\":\"\",\"logoUrl\":\"\",\"logoUuid\":\"\",\"name\":\"OAuth2\",\"purchaseId\":\"szplugin_oauth22\",\"refreshTokenValidity\":604800,\"resourceIds\":\"\",\"scope\":\"read\",\"trusted\":true,\"userInfoEndpoint\":\"\",\"uuid\":\"\",\"webServerRedirectUri\":\"\"}"
  }
}{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "applicationJson": "{\"accountLinkingTemplateUuid\":\"\",\"accountLinkingTemplates\":[{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"defaultLinking\":false,\"description\":\"系统按主子账户对应关系进行手动关联，用户添加后需要管理员审批\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"Bh4xdy2lfQPP\",\"templateName\":\"账户关联\",\"templateType\":\"账户关联\",\"templateTypeCode\":\"USERNAME\",\"uuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\"},{\"accountLinkingTemplateUuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\",\"defaultLinking\":true,\"description\":\"系统自动将主账户名称或指定的字段映射为应用的子账户\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"dKr75J08JxDY\",\"templateName\":\"账户映射\",\"templateType\":\"账户映射\",\"templateTypeCode\":\"USER_MAPPING\",\"uuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\"}],\"allSpLoginTypes\":[\"APPLICATION\",\"IDP\"],\"allowAppList\":false,\"allowUserAccessToken\":false,\"allowUserPrivileges\":false,\"applicationId\":\"plugin_jwt\",\"authScope\":\"AUTHORIZED\",\"availableFields\":[\"PRIVATE_CLOUD\",\"PUBLIC_CLOUD\",\"MOBILE\",\"IOT\",\"NETWORK\",\"OTHER\"],\"binding\":\"REDIRECT\",\"clientToken\":\"\",\"deviceTypes\":[\"WEB\"],\"display\":true,\"enterpriseId\":\"sz\",\"field\":null,\"idTokenExpiration\":600,\"loginUrl\":\"\",\"logoUrl\":\"\",\"logoUuid\":\"\",\"name\":\"JWT\",\"purchaseId\":\"szplugin_jwt4\",\"redirectUrl\":\"\",\"spLoginType\":\"IDP\",\"spLogoutUrl\":\"\",\"supportSPLogout\":false}"
  }
}

2.3.2.3. 新建OAuth2-提交表单¶

基本信息

Path： /api/bff/v1.2/application/plugin_oauth2/plus

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须
enterpriseId	string	非必须
applicationId	string	非必须
applicationJson	string	非必须
clientToken	string	非必须

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ applicationUuid	string	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "data": {
    "applicationUuid": "b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM"
  }
}

2.3.3. 修改JWT应用¶

2.3.3.1. 修改JWT-加载信息¶

注意：只有状态为禁用为应用实例方可进行修改（启用时禁止修改）。
基本信息

Path： /api/bff/v1.2/application/plugin_jwt/modify

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
enterpriseId	是
applicationId	是	plugin_jwt
applicationUuid	是

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ applicationJson	string	非必须

2.3.3.2. 修改JWT-保存数据¶

基本信息

Path： /api/bff/v1.2/application/plugin_jwt/modify

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须
enterpriseId	string	非必须
applicationUuid	string	非必须
applicationId	string	非必须
applicationJson	string	非必须
clientToken	string	非必须

Body数据示例

{
  "enterpriseId": "sz",
  "applicationUuid": "b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM",
  "applicationId": "plugin_jwt",
  "applicationJson": "{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"accountLinkingTemplates\":[{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"defaultLinking\":false,\"description\":\"系统按主子账户对应关系进行手动关联，用户添加后需要管理员审批\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"Bh4xdy2lfQPP\",\"templateName\":\"账户关联\",\"templateType\":\"账户关联\",\"templateTypeCode\":\"USERNAME\",\"uuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\"},{\"accountLinkingTemplateUuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\",\"defaultLinking\":true,\"description\":\"系统自动将主账户名称或指定的字段映射为应用的子账户\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"dKr75J08JxDY\",\"templateName\":\"账户映射\",\"templateType\":\"账户映射\",\"templateTypeCode\":\"USER_MAPPING\",\"uuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\"}],\"allAuthScopes\":[\"ALL_IDP\",\"AUTHORIZED\"],\"allowAppList\":false,\"allowUserAccessToken\":false,\"allowUserPrivileges\":false,\"applicationId\":\"plugin_jwt\",\"authScope\":\"AUTHORIZED\",\"availableFields\":[\"PRIVATE_CLOUD\",\"PUBLIC_CLOUD\",\"MOBILE\",\"IOT\",\"NETWORK\",\"OTHER\"],\"binding\":\"REDIRECT\",\"deviceTypes\":[\"WEB\"],\"display\":true,\"dynamicKeyDtos\":[],\"field\":\"OTHER\",\"idTokenExpiration\":600,\"loginUrl\":\"https://aasd.com/sss\",\"logoUuid\":\"\",\"name\":\"33333ss\",\"purchaseId\":\"szplugin_jwt4\",\"redirectUrl\":\"\",\"spLoginType\":\"IDP\",\"spLogoutUrl\":\"\",\"supportSPLogout\":false,\"themeColor\":\"\",\"uuid\":\"b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM\",\"actionType\":\"MODIFY\",\"applicationUuid\":\"b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM\"}",
  "clientToken": "adiomp8trpu3823h"
}

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null
}

2.3.4. 修改OAuth2应用¶

2.3.4.1. 修改OAuth2-加载信息¶

注意：只有状态为禁用为应用实例方可进行修改（启用时禁止修改）。
基本信息

Path： /api/bff/v1.2/application/plugin_oauth2/modify

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例
enterpriseId	是
applicationId	是	plugin_jwt
applicationUuid	是

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ applicationJson	string	非必须

2.3.4.2. 修改OAuth2-保存数据¶

基本信息

Path： /api/bff/v1.2/application/plugin_oauth2/modify

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须
enterpriseId	string	非必须
applicationUuid	string	非必须
applicationId	string	非必须
applicationJson	string	非必须
clientToken	string	非必须

Body数据示例

{
  "enterpriseId": "sz",
  "applicationUuid": "b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM",
  "applicationId": "plugin_jwt",
  "applicationJson": "{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"accountLinkingTemplates\":[{\"accountLinkingTemplateUuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\",\"defaultLinking\":false,\"description\":\"系统按主子账户对应关系进行手动关联，用户添加后需要管理员审批\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"Bh4xdy2lfQPP\",\"templateName\":\"账户关联\",\"templateType\":\"账户关联\",\"templateTypeCode\":\"USERNAME\",\"uuid\":\"50271b6a90e10872ce07ab95aa6d3d31J1qWnriE9dR\"},{\"accountLinkingTemplateUuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\",\"defaultLinking\":true,\"description\":\"系统自动将主账户名称或指定的字段映射为应用的子账户\",\"enabled\":true,\"logoUuid\":\"\",\"mapKey\":\"\",\"templateId\":\"dKr75J08JxDY\",\"templateName\":\"账户映射\",\"templateType\":\"账户映射\",\"templateTypeCode\":\"USER_MAPPING\",\"uuid\":\"253c69af1ff9f8572abf6d85a6512847ZeOWqz73dAx\"}],\"allAuthScopes\":[\"ALL_IDP\",\"AUTHORIZED\"],\"allowAppList\":false,\"allowUserAccessToken\":false,\"allowUserPrivileges\":false,\"applicationId\":\"plugin_jwt\",\"authScope\":\"AUTHORIZED\",\"availableFields\":[\"PRIVATE_CLOUD\",\"PUBLIC_CLOUD\",\"MOBILE\",\"IOT\",\"NETWORK\",\"OTHER\"],\"binding\":\"REDIRECT\",\"deviceTypes\":[\"WEB\"],\"display\":true,\"dynamicKeyDtos\":[],\"field\":\"OTHER\",\"idTokenExpiration\":600,\"loginUrl\":\"https://aasd.com/sss\",\"logoUuid\":\"\",\"name\":\"33333ss\",\"purchaseId\":\"szplugin_jwt4\",\"redirectUrl\":\"\",\"spLoginType\":\"IDP\",\"spLogoutUrl\":\"\",\"supportSPLogout\":false,\"themeColor\":\"\",\"uuid\":\"b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM\",\"actionType\":\"MODIFY\",\"applicationUuid\":\"b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM\"}",
  "clientToken": "adiomp8trpu3823h"
}

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null
}

2.3.5. 下线应用¶

下线即把应用从启用状态修改为禁用状态。

基本信息

Path： /api/bff/v1.2/application/{applicationId}/disable

Method： PUT

接口描述：
参数{applicationId}需要替换为具体的值，JWT应用为 plugin_jwt，OAuth2应用为 plugin_oauth2
请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
applicationUuid	string	必须
enabled	boolean	必须	false
applicationId	string	非必须	plugin_jwt
pluginCase	boolean	非必须	true

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ result	boolean	非必须

2.3.6. 上线应用¶

上线即把应用从禁用状态修改为启用状态。

基本信息

Path： /api/bff/v1.2/application/{applicationId}/enable

Method： PUT

接口描述：
参数{applicationId}需要替换为具体的值，JWT应用为 plugin_jwt，OAuth2应用为 plugin_oauth2

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
applicationUuid	string	必须
enabled	boolean	必须	true
applicationId	string	非必须	plugin_jwt
pluginCase	boolean	非必须	true

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ result	boolean	非必须

2.3.7. 应用列表¶

基本信息

Path： /api/bff/v1.2/application/list

Method： GET

接口描述： 查询满足条件的应用实例列表信息。

请求参数

Query

参数名称	是否必须	示例	备注
applicationField	否	PRIVATE_CLOUD	应用所属领域
applicationName	否	JWT	需要查询的应用名字，支持模糊查询
currentPage	否	1	当前页码，默认为1
pageSize	否	10	每页显示数量，默认为10
environment	否	IDaaS_PS	该接口涉及权限，如果是外部调用请传 OTHER_PS

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ totalSize	number	非必须
├─ environment	string	非必须
├─ applicationKey	null	非必须
├─ excludeSTS	null	非必须
├─ applications	object []	非必须	item 类型: object
├─ applicationInformationUuid	string	必须
├─ createTime	number	必须
├─ enterpriseId	string	必须
├─ applicationName	string	必须
├─ enabled	boolean	必须
├─ purchaseId	string	必须
├─ applicationUuid	string	必须
├─ applicationField	string	必须
├─ logoUuid	null,string	必须
├─ deviceTypes	string []	必须	item 类型: string
├─ clientId	null	必须
├─ enabledAPI	boolean	必须
├─ enableAutoLogin	boolean	必须
├─ authorized	boolean	必须
├─ enableTwoFactor	boolean	必须
├─ description	null	必须
├─ enableSyncGroup	boolean	必须
├─ syncGroupUrl	null	必须
├─ enableSyncOrgan	boolean	必须
├─ syncOrganUrl	null	必须
├─ idpSSOUrl	string	必须
├─ spLoginUrl	string,null	必须
├─ uploadPlugin	boolean	必须
├─ classifyName	null	必须
├─ allowIdpSSO	boolean	必须
├─ applicationId	string	必须

返回数据JSON示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1633776584145$9f310c14-55f2-e8ed-897a-f70890a1cf1e",
  "data": {
    "totalSize": 26,
    "environment": "OTHER_PS",
    "applicationKey": null,
    "excludeSTS": null,
    "applications": [
      {
        "applicationInformationUuid": "924a8d85de38358be05826ecf96f3fc5YM8v7DfX915",
        "createTime": 1629098100000,
        "enterpriseId": "sz",
        "applicationName": "ADFS",
        "enabled": true,
        "purchaseId": "szplugin_adfs",
        "applicationUuid": "f26cc726dfedc04f2deacd115e58a197h2jCM41HC7W",
        "applicationField": "OTHER",
        "logoUuid": "",
        "deviceTypes": [
          "WEB"
        ],
        "clientId": null,
        "enabledAPI": false,
        "enableAutoLogin": false,
        "authorized": false,
        "enableTwoFactor": false,
        "description": null,
        "enableSyncGroup": false,
        "syncGroupUrl": null,
        "enableSyncOrgan": false,
        "syncOrganUrl": null,
        "idpSSOUrl": "https://{IDaaS_server}/api/bff/v1.2/enduser/portal/sso/go_f26cc726dfedc04f2deacd115e58a197h2jCM41HC7W?access_token=",
        "spLoginUrl": "https://{IDaaS_server}/enduser/api/application/plugin_adfs/szplugin_adfs/sp_sso",
        "uploadPlugin": true,
        "classifyName": null,
        "allowIdpSSO": true,
        "applicationId": "plugin_adfs"
      }
    ]
  }
}

2.3.8. 删除应用¶

说明：只有禁用状态的应用才能删除。

基本信息

Path： /api/bff/v1.2/application/{applicationId}/archived

Method： DELETE

接口描述：
参数{applicationId}需要替换为具体的值，JWT应用为 plugin_jwt，OAuth2应用为 plugin_oauth2
请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须
applicationUuid	string	必须
applicationId	string	非必须
enterpriseId	string	非必须

Body数据示例

{
  "applicationUuid": "b7cdbe28666ed8671408fd9166acbd52YN90Si6vPLM",
  "applicationId": "plugin_jwt",
  "enterpriseId": "sz"
}

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
data	object	非必须
├─ result	boolean	非必须

2.4. 用户目录¶

2.4.1. 新建组织机构¶

基本信息

Path： /api/bff/v1.2/ud/ou/create

Method： POST

接口描述：

创建组织机构，在某一级组织机构的下创建子级ou。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
parentOuUuid	string	必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	父级组织机构 uuid
clientToken	string	必须	213sdvsdf23	幂等
enterpriseId	string	必须	jzkj	租户id
ouName	string	必须	alitest	组织机构名字
ouType	string	必须		组织机构种类	枚举: SELF_OU,EXTERNAL_OU,DEPARTMENT
sortNumber	string	非必须	0	排序号,默认为0
description	string	非必须	本级ou用于开发部门	描述
externalId	string	非必须	21dsafdas32	外部id
dictionaryValues	object []	非必须		数据字典列表	item 类型: object
├─ dictionaryUuid	string	必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	字典uuid
├─ value	string	必须	account	字典值
├─ explainText	string	非必须	count value	数据字典文本值

Body数据示例

{
  "parentOuUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr",
  "type": "",
  "name": "",
  "sortNumber": 0,
  "locationId": "",
  "externalId": "",
  "description": "",
  "managerIds": [],
  "dictionaryValues": [],
  "ouType": "SELF_OU",
  "ouName": "ESAf",
  "clientToken": "wc1gxqti2p5uifzz",
  "enterpriseId": "sz"
}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
applications	object []	非必须		允许授权的应用信息列表	item 类型: object
├─ applicationInformationUuid	string	必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	租户允许应用授权的uuid
├─ applicationName	string	必须	JWT	应用名
├─ applicationUuid	string	必须	90441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	应用uuid
├─ description	string	必须	JWT demo单点登录	描述
├─ enabled	boolean	必须	true	是否启用
├─ idpApplicationId	string	必须	aliJWT	应用模板ID
├─ logoUuid	string	必须	45441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	应用Logo uuid
externalIds	string []	非必须		外部ID列表	item 类型: string
├─		非必须	0844196
ouUuid	string	非必须	67041966f10809c8db8734ebe5e5e96dz18iCr2SuIY	创建成功后返回的uuid
parentOuUuid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	父级组织机构uuid
result	object	非必须		SCIM同步的结果信息
├─ enableLDAP	boolean	非必须	true	是否启用LDAP
├─ pushResult	object	非必须		推送结果
├─ failedCount	number	非必须	0	失败数量
├─ success	boolean	非必须	true	是否成功
├─ errorMessage	string	非必须	success	错误消息
├─ successCount	number	非必须	66	成功数量
userUuids	string []	非必须		本级组织机构包含的用户uuids （应该是空的）	item 类型: string
├─		非必须	2348966f10809c8db8734ebe5e5e96dz18iCr2SuIY

2.4.2. 修改组织机构¶

基本信息

Path： /api/bff/v1.2/ud/ou/routine/update

Method： PUT

接口描述：

更新指定组织机构信息，传入需要修改的字段。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
description	string	非必须	开发部门	描述
dictionaryValues	object []	非必须		数据字典列表	item 类型: object
├─ dictionaryUuid	string	非必须	f4efaf5b8207b9c57155449de3ac19752h0SIRn64HT	数据字典uuid
├─ dictionaryValueTransientValue	string	非必须		数据字典的值
externalId	string	必须	sadf3241	外部id
levelNumber	number	非必须	0	层级别参数
managerUDAccountUuids	string []	非必须		管理员 uuids	item 类型: string
├─		非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY
ouName	string	必须	技术部门	组织机构新名字
oldExternalId	string	非必须	abc123	老的外部id
locationId	string	非必须	20170310-0000-0001-2017-000110101000	位置id
ouUuid	string	必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	组织机构uuid
pushToSP	boolean	非必须	false

Body数据示例

{
  "description": "",
  "dictionaryValues": [],
  "externalId": "3141269003664626701",
  "levelNumber": 0,
  "managerUDAccountUuids": [],
  "ouName": "ESAf",
  "oldExternalId": "3141269003664626701",
  "locationId": "",
  "ouUuid": "a28c93218e98014720eea62233242b9ct2diIBO9OF8",
  "pushToSP": false
}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
ouUuids	string []	非必须		同级组织机构的uuids	item 类型: string
├─		非必须	56441966f10809c8db8734ebe5e5e96dz18iCr2SuIY
externalIds	string []	非必须		外部id列表	item 类型: string
├─		非必须	966f10809c8d
parentOuUuid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	父级组织机构 uuid
result	object	非必须		同步结果
├─ enableLDAP	boolean	非必须	false	是否打开LDAP的同步
├─ pushResult	object	非必须		推送结果
├─ failedCount	number	非必须	0	失败数量
├─ success	boolean	非必须	true	是否成功
├─ errorMessage	string	非必须	success	错误消息
├─ ouName	number	非必须		错误名
├─ successCount	number	非必须	66	成功数量
ouUuid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	本级组织机构的uuid

2.4.3. 删除组织机构¶

基本信息

Path： /api/bff/v1.2/ud/ou/delete

Method： POST

接口描述：

使用本API能够删除本级组织机构。注意：目标将被删除的API不能包含子级组织机构

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
ouUuid	string	必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY

Body数据示例

{"ouUuid":"a28c93218e98014720eea62233242b9ct2diIBO9OF8"}

返回数据

名称	类型	是否必须	默认值	备注	其他信息
ouUuid	string	非必须	5979cbab64971cd147f5e89f616e7659g9QPXo6Jj7S	组织机构uudi
userUuids	string []	非必须		用户uuid集合	item 类型: string
├─		非必须	[“5979cbab64971cd147f5e89f616e7659g9QPXo6Jj7S”, “3aa3e9fcf60caf1cf24f6f4af73cb9ceiV9vxLDC0r5”]
externalIds	string []	非必须		外部ID集合	item 类型: string
├─		非必须	[“6665440827777112468”]
parentOuUuid	string	非必须	5979cbab64971cd147f5e89f616e7659g9QPXo6Jj7S	父级组织机构uuid
applications	object []	非必须		已授权应用列表	item 类型: object
├─ applicationInformationUuid	string	必须	743d4894ad9412d3ff9b17c23605ea77JHpLlKKEvLD	应用uuid
├─ idpApplicationId	string	必须	jwt	应用模板ID,关联 IDPApplication
├─ applicationName	string	必须	JWT63	应用名称, 默认来自模板名称
├─ enabled	boolean	必须	false	应用是否启用, 默认false,只有应用配置完成, 检查通过才能启用
├─ applicationUuid	string	必须	4addf5911a721e48720e9d96682ad0adjTn6PS8oidY	应用uuid，关联 EnterpriseApplication
├─ logoUuid	string	必须	267613b0315dc54d64b80c5c5dcbcf34WEBR7oSJH4S	应用Logo uuid
├─ description	string	必须	描述	描述
existApplications	object	非必须		未授权应用列表
├─ applicationInformationUuid	string	必须	90901290f959d0fc1301c4944a764836zla0zcQQTzb	应用uuid
├─ idpApplicationId	string	必须	aliyun	应用模板ID,关联 IDPApplication
├─ applicationName	string	必须	JWT	应用名称, 默认来自模板名称
├─ enabled	boolean	必须	false	应用是否启用, 默认false,只有应用配置完成, 检查通过才能启用
├─ applicationUuid	string	必须	4addf5911a721e48720e9d96682ad0adjTn6PS8oidY	应用uuid，关联 EnterpriseApplication
├─ logoUuid	string	必须	267613b0315dc54d64b80c5c5dcbcf34WEBR7oSJH4S	应用Logo uuid
├─ description	string	必须	描述	应用Logo uuid
result	object	非必须		结果
├─ enableLDAP	boolean	非必须	true	是否开启同步
├─ pushResult	object	非必须		同步结果
├─ failedCount	number	非必须	1	失败次数
├─ success	boolean	非必须	true	是否成功
├─ errorMessage	string	非必须	同步失败	错误信息
├─ ouName	string	非必须	研发部	无法删除的组织机构名字
├─ successCount	number	非必须	1	成功次数

2.4.4. 查询单个组织机构¶

基本信息

Path： /api/bff/v1.2/ud/ou/detail

Method： GET

接口描述：

获取指定组织机构的详情。

请求参数

Query

参数名称	是否必须	示例	备注
ouUuid	是	90c30bb9dc16f5ac70775a6e49a4d0598GENkHvIRE6	组织机构 uuid

返回数据

名称	类型	是否必须	默认值	备注	其他信息
ouUuid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	当前组织机构的uuid
createTime	number	非必须	1548086400000	创建时间
archived	boolean	非必须	false	是否归档
dictionaryList	object []	非必须		数据字典列表	item 类型: object
├─ dictionaryUuid	string	非必须	ed441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	数据字典uuid
├─ createTime	string	非必须	2019-07-22 21:21	创建时间
├─ archived	boolean	非必须	false	是否归档
├─ fieldName	string	非必须	abc	属性名称
├─ fieldValue	string	非必须	dididi	属性值
├─ type	string	非必须	UD_ACCOUNT	数据字典属于账户还是OU还是别的
├─ fieldType	string	非必须	TEXT	本屌数据字典的类型，下拉框、文本框等。
├─ selectFieldOptions	object []	非必须		下拉单选框中的选项列表	item 类型: object
├─ optionId	string	非必须	23sv4324x556dxcvxvw34dsf34t	选项id
├─ optionLabel	string	非必须	option	选项名称
├─ optionValue	string	非必须	values	选项值
├─ enabled	boolean	非必须	true	是否启用
├─ required	boolean	非必须	true	是否必填
├─ remark	string	非必须	用于账户	备注
├─ unique	boolean	非必须	true	值是否能需要唯一
├─ modifiable	boolean	非必须	true	值是否在创建后可以修改
dictionaryValues	object []	非必须		数据字典值列表	item 类型: object
├─ dictionaryUuid	string	非必须	90c30bb9dc16f5ac70775a6e49a4d0598GENkHvIRE6	数据字典uuid
├─ value	string	非必须	account	值
├─ explainText	string	非必须		在复杂文本框中的数据字典提示信息
enterpriseUuid	string	非必须	as334sdgfvs809c8db8734ebe5e5e96dz18iCr2SuIY	租户uuid
description	string	非必须	本级ou属于根ou	描述
rootNode	boolean	非必须	true	是否是根
ouName	string	非必须	aliyun	当前组织机构的名字
externalId	string	非必须	14654673423	外部id
type	string	非必须	DEPARTMENT	种类
parentOUUuid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	父级组织机构 uuid
parentDirectory	string	非必须	ALI home	父级目录
managerUDAccountUuids	string []	非必须		管理员uuid列表	item 类型: string
├─		非必须	90c30bb9dc16f5ac70775a6e49a4d0598GENkHvIRE6
locationId	string	非必须	20170310-0000-0001-2017-000110101000	所属区域ID
ddtalkDepartId	string	非必须	5432312vf	钉钉中的部门ID
enterpriseWeChatDeptId	string	非必须	2135sd	微信中的部门ID
enabled	boolean	非必须	true	是否启用
levelNumber	number	非必须	0	排序编号

2.4.5. 查询根组织机构¶

基本信息

Path： /api/bff/v1.2/ud/ou/root

Method： GET

接口描述：

获取当前租户的根组织机构基本信息，注意：需要有默认管理员权限才能够获取到。
请求参数
无
返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ ouUuid	string	非必须	OU uuid
├─ externalId	string	非必须	外部id
├─ ouName	string	非必须	OU名称

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1634003931450$9007a750-c1f4-9059-d351-8114531a2f41",
  "data": {
    "ouUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr",
    "externalId": "6725407790200354692",
    "ouName": "IDaaS"
  }
}

2.4.6. 查询组织下一级组织机构¶

基本信息
Path： /api/bff/v1.2/ud/ou/children
Method： GET

接口描述：

获取某个组织机构下的直属子级组织机构列表，仅包含直系子级，不包含子级内嵌套的组织机构。

注意： IDaaS返回的组织机构分为人事组织和应用群组两种大类型的组织，请以人事组织节点为公司的根节点
请不要在应用群组组织节点下进行添加组织，关于人事组织和应用群组的组织节点类型参考返回数据的说明

请求参数

Query

参数名称	是否必须	示例	备注
ouUuid	是	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	指定当前的组织机构 uuid

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ ous	object []	非必须			item 类型: object
├─ isParent	boolean	必须
├─ accountNum	number	必须
├─ edit	boolean	必须		允许编辑?
├─ show	boolean	必须
├─ icon	string	必须
├─ ouData	object	必须
├─ ouUuid	string	非必须
├─ type	string	必须
├─ ouName	string	必须		OU名称
├─ levelNumber	number	必须		排序号
├─ checked	boolean	必须
├─ id	string	必须
├─ parentOuUuid	string	必须		父OU uuid
├─ showAccNum	boolean	必须
├─ status	boolean	必须		OU状态
├─ nodeType	String	必须	SELF_CREATED	OU节点类型	ENTERPRISE_ROOT - 公司根节点; MASTER_TREE_ROOT -人事组织节点; APP_GROUP - 应用群组节点; SELF_CREATED - 自建节点
├─ mainData	boolean	必须		是否是人事组织下的组织	true表示是人事组织下的组织机构 ;false一般代表为应用群组下的组织

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1634003931729$27d72bb2-3a22-77ec-c7ec-d9a1b805644b",
  "data": {
    "ous": [
      {
        "isParent": false,
        "accountNum": 0,
        "edit": true,
        "show": true,
        "icon": "/static/plugins/zTree_v3-3.5.26/css/metroStyle/img/diy/ou.png",
        "ouData": {
          "ouUuid": "a5dc9b0662bb1aba6e0c2bbf7dab2c89GIZHVEZXuS7"
        },
        "type": "SELF_OU",
        "ouName": "SES",
        "levelNumber": 0,
        "checked": false,
        "id": "a5dc9b0662bb1aba6e0c2bbf7dab2c89GIZHVEZXuS7",
        "parentOuUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr",
        "showAccNum": false,
        "status": true,
        "nodeType":"SELF_CREATED",
        "mainData":true
      }
    ]
  }
}

2.4.7. 查询某组织下组织机构列表¶

基本信息
Path： /api/bff/v1.2/ud/ou/list?paramsType=ouName&paramsValue=&ouUuid=b7fa7e97ab9a9f74eeaf632409941f11nFCXGZ402uG&pageSize=10&currentPage=1&effectiveStatus=0
Method： GET

接口描述：

获取某个组织机构下的直属子级组织机构列表，包含子级内嵌套的组织机构。

请求参数

Query

参数名称	是否必须	备注
paramsType	否	查询类型：ouName/externalId
paramsValue	否	查询选定类型的关键字
ouUuid	是	组织uuid
effectiveStatus	是	是否生效：0-所有，1-已生效，2-未生效
pageSize	是	每页数量
currentPage	是	当前页码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ totalSize	number	非必须		总数
├─ ous	object []	非必须			item 类型: object
├── ouUuid	string	必须
├── createTime	number	必须
├── ouName	string	必须
├── description	string	非必须
├── parentDirectory	string	必须
├── type	string	必须
├── enabled	boolean	必须
├── nodeType	String	必须	SELF_CREATED	OU节点类型	ENTERPRISE_ROOT - 公司根节点; MASTER_TREE_ROOT -人事组织节点; APP_GROUP - 应用群组节点; SELF_CREATED - 自建节点
├── mainData	boolean	必须
├── refOrgUuid	string	非必须
├── refOrgExternalId	string	非必须
├── refOrgDirectory	string	非必须
├── effectiveTime	number	非必须
├── effective	boolean	必须
返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1660809098530$2319e68e-86a5-84ca-f0d4-4dffc6d056b4",
  "data": {
    "totalSize": 2,
    "ous": [
      {
        "ouUuid": "4204ccad67c31ed3cf7bdf26f85f81e5CmWIr6m4cdo",
        "createTime": 1660808526000,
        "ouName": "zuzhi001-1",
        "description": "",
        "parentDirectory": "/人事组织/4.17.13测试/排序测试001/",
        "type": "SELF_OU",
        "enabled": true,
        "nodeType": "SELF_CREATED",
        "mainData": true,
        "refOrgUuid": null,
        "refOrgExternalId": null,
        "refOrgDirectory": null,
        "effectiveTime": null,
        "effective": true
      },
      {
        "ouUuid": "cddafb020e470a14b9573f66de2c8dcfT2jMv9T4GXp",
        "createTime": 1656901760000,
        "ouName": "排序测试001",
        "description": "",
        "parentDirectory": "/人事组织/4.17.13测试/",
        "type": "SELF_OU",
        "enabled": true,
        "nodeType": "SELF_CREATED",
        "mainData": true,
        "refOrgUuid": null,
        "refOrgExternalId": null,
        "refOrgDirectory": null,
        "effectiveTime": null,
        "effective": true
      }
    ]
  }
}

2.4.8. 查询组织下直属账户列表¶

基本信息
Path： /api/bff/v1.2/ud/account/list
Method： GET
接口描述：
查询组织下的直属账户，支持按条件分页检索

请求参数
Query

参数名称	是否必须	示例	备注
ouUuid	是	9b67ef225d9981564d8219e1569ebf81MfIm1BHnRga	组织uuid
currentPage	是	1	当前页数
pageSize	是	10	每页数量
paramsType	否	username	参数类型名称-搜索使用，有用户名-username 手机号-phoneNumber 显示名称-displayName 邮箱-email
paramsValue	否	zhangsan	参数值-搜索使用

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ list	object []	必须	账户	item 类型: object
├─ uuid	string	必须	账户uuid
├─ createTime	string	必须	创建时间
├─ archived	boolean	必须	是否逻辑删除
├─ userUuid	string	必须
├─ enterpriseUuid	string	必须	所属公司uuid
├─ createTimeTimestamp	number	必须	创建时间戳
├─ udAccountType	string	必须	账户类型	mock: SELF_ACCOUNT
├─ email	string	必须	邮箱
├─ username	string	必须	账户名称
├─ displayName	string	必须	显示名称
├─ expireTime	string,null	必须	过期时间
├─ externalId	string	必须	账户外部ID
├─ ouExternalId	null	必须	所属主组织外部ID
├─ description	string	必须	描述
├─ ouUuid	string	必须	所属主组织uuid
├─ ouDirectory	string	必须	所属主组织路径
├─ admin	boolean	必须	是否是超管
├─ phoneNumber	null	必须	手机号码
├─ enterpriseFullName	string	必须	所属公司全称
├─ externalOuId	null	必须
├─ systemUserUuid	string	必须	关联登录用户uuid
├─ publicKey	null	非必须
├─ caProvider	null	非必须
├─ sequenceNumber	number	必须	自身排序号
├─ deletable	boolean	必须
├─ phoneRegion	null	必须	手机号区域
├─ enabled	boolean	必须	是否启用
├─ displayOrder	number	非必须
├─ member	boolean	非必须
├─ perPageSize	number	必须
├─ totalSize	number	必须
├─ pageNumber	number	必须
├─ hasNext	boolean	必须
├─ hasPrevious	boolean	必须
├─ showSort	string	必须
├─ totalPages	string	必须
├─ currentPage	string	必须

2.4.9. 新建组¶

基本信息

Path： /api/bff/v1.2/ud/group/create

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
ouUuid	string	必须	所属组织uuid
groupName	string	必须	组名称
description	string	非必须	组描述
externalId	string	非必须	组外部id
dictionaryValues	object []	非必须	组扩展属性值	item 类型: object
├─ dictionaryUuid	string	非必须
├─ value	string	非必须
clientToken	string	非必须

Body数据示例

{
  "ouUuid": "ebb3fabc893ff0dd35862f1e6a826d6bmBvgq7aXJ0I",
  "groupName": "zuzhisss",
  "description": "",
  "managerIds": [],
  "externalId": "",
  "dictionaryValues": [
    {
      "dictionaryUuid": "be563a03098b21d5f3325bf9aca393957bR7V2tuJoT",
      "dictionaryValueTransientValue": "",
      "value": "xxx"
    }
  ],
  "exclusiveGroupUuids": [],
  "clientToken": "12eezn6zz73re8zm"
}

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	null	非必须	创建时间
├─ archived	boolean	非必须
├─ parentUUid	string	非必须	所属组织uuid

2.4.10. 修改组¶

基本信息

Path： /api/bff/v1.2/ud/group/routine/update/{uuid}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
uuid		组uuid

Body

名称	类型	是否必须	备注	其他信息
uuid	string	必须	组uuid
ouUuid	string	非必须	所属组织uuid
groupName	string	必须	组名字
description	string	非必须
dictionaryValues	object []	非必须	数据字典的值（扩展属性）	item 类型: object
├─ dictionaryUuid	string	非必须
├─ value	string	非必须
├─		非必须
externalId	string	必须	组外部ID（不修改时传旧的组外部ID值，此时oldExternalId也必须上传相等的ID值）
oldExternalId	string	非必须	旧的组外部ID

Body数据示例

{
  "uuid": "acc5566a79dfe844aeb836d3c3f050afDZ2U0FUit8C",
  "ouUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr",
  "groupName": "GGs",
  "description": "fs",
  "dictionaryValues": [],
  "externalId": "a",
  "oldExternalId": "a"
}

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	string	非必须
├─ archived	boolean	非必须
├─ parentUUid	string	非必须	所属组织uuid

2.4.11. 删除组¶

基本信息

Path： /api/bff/v1.2/ud/group/delete/{uuid}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
uuid		组uuid

Body

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	null	非必须
├─ archived	boolean	非必须
├─ parentUUid	string	非必须	所属组织uuid

2.4.12. 查询单个组¶

基本信息

Path： /api/bff/v1.2/ud/group/routine/lookup/{uuid}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uuid		组uuid

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ formDto	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	string	非必须
├─ archived	boolean	非必须
├─ dictionaryList	string []	非必须		item 类型: string
├─		非必须
├─ dictionaryValues	string []	非必须		item 类型: string
├─		非必须
├─ enterpriseUuid	string	非必须
├─ managerUDAccountUuids	string []	非必须		item 类型: string
├─		非必须
├─ groupName	string	非必须	组名称
├─ type	string	非必须
├─ externalId	string	非必须	组外部ID
├─ description	string	非必须
├─ ouUuid	string	非必须
├─ udAccountManagers	string []	非必须		item 类型: string
├─		非必须
├─ oldExternalId	string	非必须

2.4.13. 查询组列表¶

基本信息

Path： /api/bff/v1.2/ud/group/list?paramsType=name&paramsValue=&ouUuid=ebb3fabc893ff0dd35862f1e6a826d6bmBvgq7aXJ0I&types=SELF_GROUP%2C%20EXTERNAL_GROUP&pageSize=10&currentPage=1

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
paramsType		查询类型：name/externalId
paramsValue		查询选定类型的关键字
ouUuid		组织uuid
types		类型：SELF_GROUP，EXTERNAL_GROUP（自建和导入的）
pageSize		每页数量
currentPage		当前页码

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ list	object[]	非必须
├── uuid	string	非必须	组uuid
├── createTime	string	非必须
├── archived	boolean	非必须
├── enterpriseUuid	string	非必须
├── groupName	string	非必须
├── type	string	非必须
├── externalId	string	非必须
├── description	string	非必须
├── ouUuid	string	非必须
├── ouDirectory	string	非必须
├── ouName	string	非必须
├── defaultGroup	string	非必须
├── childrenUDAccountNumber	string	非必须
├── stauts	string	非必须
├─ ouUuid	string	非必须	组外部ID
├─ ouName	string	非必须
├─ types	string []	非必须		item 类型: string

以上为主要数据，完整数据请看以下示例返回示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1660807209316$e1d020c9-b03e-3e91-0358-575e95c00bcb",
  "data": {
    "list": [
      {
        "uuid": "60bb28edd1bd2f844396ab7fa7e37a4avirkg6yw5jB",
        "createTime": "2022-07-21 10:23",
        "archived": false,
        "enterpriseUuid": "3e9dc4cb8a03b08d9e7a6f6e48d3b0ceCrDbD9peTG0",
        "groupName": "组1互斥组",
        "type": "SELF_GROUP",
        "externalId": "8742816273845383855",
        "description": "",
        "ouUuid": "ebb3fabc893ff0dd35862f1e6a826d6bmBvgq7aXJ0I",
        "ouDirectory": "/人事组织",
        "defaultGroup": false,
        "ouName": "人事组织",
        "childrenUDAccountNumber": 0,
        "stauts": true
      }
    ],
    "perPageSize": 10,
    "totalSize": 2,
    "pageNumber": 1,
    "sortName": "",
    "sort": null,
    "sortCriterion": null,
    "searchId": null,
    "dir": "asc",
    "sortDir": "desc",
    "ouUuid": "ebb3fabc893ff0dd35862f1e6a826d6bmBvgq7aXJ0I",
    "ouName": "人事组织",
    "name": "",
    "paramsType": "externalId",
    "paramsValue": "",
    "types": [
      "SELF_GROUP",
      "EXTERNAL_GROUP"
    ],
    "rootNode": false,
    "maxAdmin": true,
    "shortName": "xx测试",
    "draw": 0,
    "managerUDAccounts": [],
    "edit": true,
    "totalChildrenSize": 0,
    "sortDirection": {
      "code": 1,
      "name": "descending"
    },
    "objectsPerPage": 10,
    "fullListSize": 2,
    "startIndex": 0,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 10,
    "hasNext": false,
    "hasPrevious": false,
    "showSort": "ASC"
  }
}

2.4.14. 组添加成员¶

基本信息

Path： /api/bff/v1.2/ud/group/members/account/add

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
groupParentUuid	string	必须	父账户组uuid
childrenAccountsIds	string[]	必须	子账户UUIDS
clientToken	string	非必须

Body数据示例

{
  "groupParentUuid": "542d2ec90143dce38af0925566aaac864lu7uVMMHHV",
  "childrenAccountsIds": [
    "60679eab0214d22d28de1574acd8694aOev2q2JC8i1"
  ],
  "clientToken": "n9th9mhg6en6fu5n"
}

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	string	非必须
├─ archived	boolean	非必须
├─ dictionaryList	object []	非必须		item 类型: object
├─ dictionaryValues	object []	非必须		item 类型: object
├─ uuids	string []	非必须		item 类型: string
├─ parentUUid	string []	非必须		item 类型: string
├─ applicationInformationDtos	object []	非必须		item 类型: object
├─ existApplications	object []	非必须		item 类型: object
├─ resultDto	object	非必须		item 类型: string
├─ ouUuid	string	非必须
├─ udGroupUuid	string	非必须
├─ externalId	string	非必须	组外部ID
├─ removeResult	string	非必须
├─ ouUuid	string	非必须
├─ deleteAppSyncOUInfos	object []	非必须		item 类型: object
├─ applications	object []	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1660803767651$804ca995-8400-eaf5-6908-96a24f80ae3e",
  "data": {
    "uuid": "542d2ec90143dce38af0925566aaac864lu7uVMMHHV",
    "createTime": null,
    "archived": false,
    "dictionaryList": [],
    "dictionaryValues": [],
    "uuids": [
      "60679eab0214d22d28de1574acd8694aOev2q2JC8i1"
    ],
    "externalIds": [],
    "parentUUid": "542d2ec90143dce38af0925566aaac864lu7uVMMHHV",
    "applicationInformationDtos": [],
    "existApplications": [],
    "resultDto": {
      "enableLDAP": false,
      "pushResult": {
        "success": true,
        "errorMessage": "添加成功"
      },
      "applications": []
    },
    "ouUuid": null,
    "udGroupUuid": null,
    "externalId": null,
    "removeResult": true,
    "deleteAppSyncOUInfos": [],
    "applications": []
  }
}

2.4.15. 组移除成员¶

基本信息

Path： /api/bff/v1.2/ud/group/members/account/remove

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
groupParentUuid	string	必须	父账户组uuid
childrenAccountsIds	string[]	必须	子账户UUIDS
clientToken	string	非必须

Body数据示例

{
  "groupParentUuid": "542d2ec90143dce38af0925566aaac864lu7uVMMHHV",
  "childrenAccountsIds": [
    "60679eab0214d22d28de1574acd8694aOev2q2JC8i1"
  ]
}

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ uuid	string	非必须	组uuid
├─ createTime	string	非必须
├─ archived	boolean	非必须
├─ dictionaryList	object []	非必须		item 类型: object
├─ dictionaryValues	object []	非必须		item 类型: object
├─ uuids	string []	非必须		item 类型: string
├─ parentUUid	string []	非必须		item 类型: string
├─ applicationInformationDtos	object []	非必须		item 类型: object
├─ existApplications	object []	非必须		item 类型: object
├─ resultDto	object	非必须		item 类型: string
├─ ouUuid	string	非必须
├─ udGroupUuid	string	非必须
├─ externalId	string	非必须	组外部ID
├─ removeResult	string	非必须
├─ ouUuid	string	非必须
├─ deleteAppSyncOUInfos	object []	非必须		item 类型: object
├─ applications	object []	非必须

以上为主要数据，完整数据请看以下示例返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1660803916971$42ddc960-d882-9df5-599e-5554bc210085",
  "data": {
    "uuid": null,
    "createTime": null,
    "archived": false,
    "dictionaryList": [],
    "dictionaryValues": [],
    "uuids": [],
    "externalIds": [],
    "parentUUid": null,
    "applicationInformationDtos": [],
    "existApplications": [],
    "resultDto": {
      "enableLDAP": false,
      "pushResult": {
        "success": true,
        "errorMessage": "保存成功"
      },
      "applications": []
    },
    "ouUuid": null,
    "udGroupUuid": null,
    "externalId": null,
    "removeResult": true,
    "deleteAppSyncOUInfos": [],
    "applications": []
  }
}

2.4.16. 组成员查询¶

基本信息

Path： /api/bff/v1.2/ud/group/members/account/list/attached/{uuid}?uuid={uuid}&username={username}&pageSize={pageSize}&currentPage={currentPage}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
uuid		组uuid
username		用户名
pageSize		每页数量
currentPage		当前页码

返回数据

名称	类型	是否必须	备注
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ list	object	非必须
├── uuid	string	非必须	组uuid
├── createTime	string	非必须
├── archived	boolean	非必须
├── userUuid	string	非必须
├── enterpriseUuid	string	非必须
├── udAccountType	string	非必须
├── email	string	非必须
├── username	string	非必须
├── displayName	string	非必须
├── expireTime	string	非必须
├── externalId	string	非必须
├── description	string	非必须
├── ouUuid	string	非必须
├── ouDirectory	string	非必须
├── phoneNumber	string	非必须
├── enterpriseFullName	string	非必须
├── externalOuId	string	非必须
├── systemUserUuid	string	非必须
├── phoneRegion	string	非必须
├─ ouUuid	string	非必须

以上为主要数据，完整数据请看以下示例返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1660891369372$65ccd0ab-4798-0aa5-5cbc-240605782b16",
  "data": {
    "list": [
      {
        "uuid": "1edcf450450892f6230f3ba76721737b5DKT87CqE8h",
        "createTime": "2022-08-19 14:29",
        "archived": false,
        "userUuid": "1edcf450450892f6230f3ba76721737b5DKT87CqE8h",
        "enterpriseUuid": "ad3a146852f567caa0ab1fb78c85dd38zADWeKs6iSz",
        "createTimeTimestamp": 1660890597000,
        "udAccountType": "SELF_ACCOUNT",
        "email": "xxx@qq.com",
        "username": "xdfasfa",
        "displayName": "xdfasfa",
        "expireTime": "2116-12-31",
        "externalId": "327095131311927330",
        "ouExternalId": null,
        "description": "通过注册添加",
        "ouUuid": "df9920355632ae0d4e692068e0d221ecJ2DkznXIjbG",
        "ouDirectory": "/人事组织/",
        "admin": false,
        "phoneNumber": "18383375354",
        "enterpriseFullName": "IDaaS",
        "externalOuId": null,
        "systemUserUuid": "71fb49834e74aff0b49677147ff6f0171SADy1YJ8kk",
        "publicKey": null,
        "caProvider": null,
        "sequenceNumber": 0,
        "deletable": true,
        "phoneRegion": "86",
        "enabled": true,
        "displayOrder": 0,
        "member": false,
        "effectiveTime": null,
        "effective": true
      }
    ],
    "perPageSize": 10,
    "totalSize": 1,
    "pageNumber": 1,
    "sortName": "",
    "sort": null,
    "sortCriterion": null,
    "searchId": null,
    "dir": "",
    "sortDir": "asc",
    "username": "",
    "displayName": "",
    "groupName": "test",
    "udGroupDto": null,
    "childrenUDGroupDto": null,
    "udGroupChildrenAccounts": null,
    "ouUuid": "df9920355632ae0d4e692068e0d221ecJ2DkznXIjbG",
    "sortDirection": {
      "code": 1,
      "name": "descending"
    },
    "fullListSize": 1,
    "objectsPerPage": 10,
    "startIndex": 0,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 10,
    "hasNext": false,
    "hasPrevious": false,
    "showSort": "ASC"
  }
}

2.4.17. 账户列表¶

基本信息

Path： /api/bff/v1.2/user/list

Method： GET

接口描述：

获取企业下全量人员账户列表，包含分页，检索

请求参数

Query

参数名称	是否必须	示例	备注
currentPage	否	1	当前页码(默认1)
pageSize	否	10	每页条数（默认10）
email	否	xxx@idsmanager.com	邮箱,用户名,显示名称
enabledAccount	否	true	账户启用/禁用
expiredAccount	否	false	账户是否过期
lockedAccount	否	true	账户是否锁定
fieldValue	否	sex	数据字典字段值，如sex
dictionaryValue	否	男	数据字典值,如男、女；fieldValue和dictionaryValue都不为空，才会去筛选
dictionaryUuid	否		数据字典UUID
decrypt	否		decrypt:传true时，返回解密的email以及phoneNumber

返回数据

名称	类型	是否必须	备注	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ perPageSize	number	非必须
├─ totalSize	number	非必须
├─ pageNumber	number	非必须
├─ sortName	null	非必须
├─ sort	null	非必须
├─ sortCriterion	null	非必须
├─ searchId	null	非必须
├─ dir	null	非必须
├─ sortDir	string	非必须
├─ paramsType	null	非必须
├─ paramsValue	string	非必须
├─ accurate	boolean	非必须
├─ lastTotalNumber	number	非必须
├─ email	string	非必须
├─ twtFactor	null	非必须
├─ enabledAccount	null	非必须
├─ lockedAccount	null	非必须
├─ expiredAccount	null	非必须
├─ userQueryTypeEnum	string	非必须
├─ fieldValue	null	非必须
├─ dictionaryValue	null	非必须
├─ dictionaryUuid	null	非必须
├─ sortDirection	object	非必须
├─ code	number	非必须
├─ name	string	非必须
├─ list	object []	非必须	账户信息集合	item 类型: object
├─ uuid	string	必须	账户uuid
├─ createTime	string	必须	创建时间
├─ archived	boolean	必须	是否逻辑删除
├─ dictionaryList	string []	必须	账户数据字典	item 类型: string
├─ dictionaryValues	string []	必须	账户数据字典值	item 类型: string
├─ userUuid	string	必须	账户uuid
├─ username	string	必须	账户名称
├─ email	string	必须	邮箱
├─ phoneNumber	null,string	必须	手机号码
├─ enterpriseFullName	string	必须	公司全称
├─ externalId	string	必须	账户外部ID
├─ description	string	必须	账户描述
├─ userId	string	必须	账户ID
├─ user2factor	boolean	必须	是否2次认证
├─ locked	boolean	必须	是否锁定
├─ admin	boolean	必须	是否是超管
├─ ouDirectory	string	必须	主组织目录
├─ udAccountType	string	必须	账户类型
├─ displayName	string	必须	显示名称
├─ expired	boolean	必须	是否过期
├─ expireDate	string	必须	过期时间
├─ logoUuid	null	必须
├─ deletable	boolean	必须
├─ activated	boolean	必须	是否激活
├─ realNameFlag	boolean	必须
├─ idCard	null	必须
├─ realName	null	必须
├─ enabled	boolean	必须
├─ ouExternalId	string	必须	所属主组织外部ID
├─ ouUuid	string	必须	所属主组织uuid
├─ ouName	string	必须	所属主组织m名
├─ ouParentExternalId	string,null	必须
├─ ouParentUuid	string,null	必须
├─ ouParentName	string,null	必须	所有所属组织名称集合
├─ allOuUuids	string []	必须	所有所属组织uuid集合	item 类型: string
├─ phoneRegion	string	必须	手机号码区域
├─ objectsPerPage	number	非必须
├─ fullListSize	number	非必须
├─ startIndex	number	非必须
├─ totalPages	number	非必须
├─ currentPage	number	非必须
├─ pageSize	number	非必须
├─ hasNext	boolean	非必须
├─ hasPrevious	boolean	非必须
├─ showSort	string	非必须

2.4.18. 新建账户¶

基本信息

Path： /api/bff/v1.2/ud/account/create

Method： POST

接口描述：

创建账户接口，在当前一级组织机构下创建账户。建议先创建再赋予属性。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	其他信息
ouUuid	string	必须
username	string	必须
displayName	string	必须
password	string	必须
phoneNumber	string	非必须
phoneRegion	string	非必须
email	string	非必须
expireTime	string	非必须
description	string	非必须
externalId	string	非必须
dictionaryValues	object []	非必须	item 类型: object
├─ dictionaryUuid	string	必须
├─ dictionaryValueTransientValue	string	必须
├─ type	string	必须
groupUuids	string []	非必须	item 类型: string
├─		非必须
displayOrder	number	非必须
clientToken	string	非必须

Body数据示例

{
  "ouUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr",
  "username": "liszoew",
  "displayName": "liszoew",
  "password": "xxxxxxxx",
  "phoneNumber": "",
  "phoneRegion": "",
  "email": "liszoew@idaas.net",
  "expireTime": "",
  "description": "",
  "externalId": "",
  "dictionaryValues": [
    {
      "dictionaryUuid": "d0d0ad7bcb0881f968bf86004b108f5fOoThPxdLHrA",
      "dictionaryValueTransientValue": "",
      "type": "UD_ACCOUNT"
    },
    {
      "dictionaryUuid": "7c0424a1a96acb1aeae482478bce12dbYV68zMPcVL7",
      "dictionaryValueTransientValue": "",
      "type": "UD_ACCOUNT_ORGANIZATION"
    }
  ],
  "groupUuids": [],
  "displayOrder": 0,
  "clientToken": "pt0k1sspeys83643"
}

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ userUuid	string	非必须
├─ userUuids	string []	非必须	item 类型: string
├─		非必须
├─ externalIds	string []	非必须	item 类型: string
├─		非必须
├─ parentOuUuid	string	非必须
├─ applications	string []	非必须	item 类型: string
├─		非必须
├─ existApplications	string []	非必须	item 类型: string
├─		非必须
├─ result	object	非必须
├─ enableLDAP	boolean	非必须
├─ pushResult	object	非必须
├─ failedCount	number	非必须
├─ errorMessage	string	非必须
├─ successCount	number	非必须
├─ applications	string []	非必须	item 类型: string
├─		非必须

2.4.19. 修改账户¶

基本信息

Path： /api/bff/v1.2/ud/account/routine/update

Method： PUT

接口描述：

更新用户常规属性，处理提交保存,可以不用全部数据都重新提交，只提交需要修改的部分。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	其他信息
userUuid	string	必须
username	string	非必须
displayName	string	必须
description	string	非必须
email	string	非必须
phoneNumber	null	非必须
phoneRegion	string	非必须
expireTime	string	非必须
externalId	string	非必须
dictionaryValues	object []	非必须	item 类型: object
├─ dictionaryUuid	string	必须
├─ dictionaryValueTransientValue	string	必须
├─ explainText	string	必须
├─ type	string	必须
displayOrder	number	非必须
ouUuid	string	非必须

Body数据示例

{
  "userUuid": "507920baf1d0fce7906a05f1e1de73b6bz9FCH4Ln43",
  "username": "liszoew",
  "displayName": "liszoew",
  "description": "",
  "email": "liszoew@idaas.net",
  "phoneNumber": null,
  "phoneRegion": "86",
  "expireTime": "2116-12-31",
  "externalId": "6381842238759715398",
  "dictionaryValues": [
    {
      "dictionaryUuid": "d0d0ad7bcb0881f968bf86004b108f5fOoThPxdLHrA",
      "dictionaryValueTransientValue": "",
      "explainText": "",
      "type": "UD_ACCOUNT"
    },
    {
      "dictionaryUuid": "7c0424a1a96acb1aeae482478bce12dbYV68zMPcVL7",
      "dictionaryValueTransientValue": "",
      "explainText": "",
      "type": "UD_ACCOUNT_ORGANIZATION"
    }
  ],
  "displayOrder": 0,
  "ouUuid": "00451a926e5ed2aaf1a5d5fc720ccd192PdndYtOLLr"
}

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ userUuid	string	非必须
├─ userUuids	string []	非必须	item 类型: string
├─		非必须
├─ externalIds	string []	非必须	item 类型: string
├─		非必须
├─ parentOuUuid	string	非必须
├─ applications	string []	非必须	item 类型: string
├─		非必须
├─ existApplications	string []	非必须	item 类型: string
├─		非必须
├─ result	object	非必须
├─ enableLDAP	boolean	非必须
├─ pushResult	object	非必须
├─ failedCount	number	非必须
├─ errorMessage	string	非必须
├─ successCount	number	非必须
├─ applications	string []	非必须	item 类型: string
├─		非必须

2.4.20. 删除账户¶

逻辑删除，移动到离职人员中。

基本信息

Path： /api/bff/v1.2/user/archive

Method： POST

接口描述：

将账户进行离职操作，实际上是逻辑删除。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Query

参数名称	是否必须	示例	备注
access_token	否

Body

名称	类型	是否必须	默认值	备注	其他信息
userUuid	string	必须	18e6f36277164ee278824fa4c999e960JCawF0Zn8au	用户uuid

返回数据

名称	类型	是否必须	默认值	备注	其他信息
userUuid	string	非必须	44cfbcffb709790f325792352090cf19uPd9TolSWLP	用户uuid
ouUuids	string []	非必须		组织机构uuid集合	item 类型: string
├─		非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY
ouParentUUid	string	非必须	08441966f10809c8db8734ebe5e5e96dz18iCr2SuIY	父级组织机构uuid
externalIds	string []	非必须		外部id集合	item 类型: string
├─		非必须	3085244083252839896
applications	object	非必须		允许授权的应用信息列表
├─ applicationName	string	必须	JWTzb0030	应用名称, 默认来自模板名称
├─ applicationUuid	string	必须	5b28bd6b20f64c6cfc7aa1d54a75e5a8z6iD7abc22b	应用uuid，关联 EnterpriseApplication
├─ enableSCIM	boolean	必须	true	是否开启SCIM推送
├─ enabled	boolean	必须	true	应用是否启用, 默认false,只有应用配置完成, 检查通过才能启用
├─ idpApplicationId	string	必须	jwt	应用模板ID,关联 IDPApplication
├─ logoUuid	string	必须	b0c893cb8f0171dfee6b01e2bdfc3fceRPz14MlRKRo	应用Logo uuid
scimRsult	object	非必须		同步结果
├─ enableLDAP	boolean	非必须	true	是否开启同步
├─ pushResult	object	非必须		同步结果
├─ failedCount	number	非必须	1	错误次数
├─ success	boolean	非必须	true	是否成功
├─ errorMessage	string	非必须	同步成功	错误信息
├─ successCount	number	非必须	3	成功次数

2.4.21. 查询单个账户¶

基本信息

Path： /api/bff/v1.2/ud/account/routine/lookup

Method： GET

接口描述：

更新用户常规属性时，先拉取用户的信息，用于前端展示

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json	内容类型
Authorization	Bearer {access_token}	是	Bearer 68807578-c046-4a46-9bdc-284539e28d95	用户凭证

Query

参数名称	是否必须	示例	备注
userUuid	是	2e61ec760b6656bf1cf67f01d485a2fbK9BbMD81Q6R	用户uuid
ouUuid	是	2e61ec760b6656bf1cf67f01d485a2fbK9BbMD81Q6R	组织uuid

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ userInformation	object	非必须
├─ userUuid	string	非必须
├─ createTime	string	非必须
├─ archived	boolean	非必须
├─ enterpriseUuid	string	非必须
├─ udAccountType	string	非必须
├─ email	string	非必须
├─ username	string	非必须
├─ phoneNumber	null	非必须
├─ existedPhoneNumber	null	非必须
├─ expireTime	string	非必须
├─ externalId	string	非必须
├─ description	string	非必须
├─ ouUuid	string	非必须
├─ usernameOk	string	非必须
├─ displayName	string	非必须
├─ phoneRegion	string	非必须
├─ displayOrder	number	非必须
├─ dictionaryList	object []	非必须	item 类型: object
├─ dictionaryUuid	string	非必须
├─ createTime	number	非必须
├─ fieldName	string	非必须
├─ fieldValue	string	非必须
├─ type	string	非必须
├─ fieldType	string	非必须
├─ selectFieldOptions	object []	非必须	item 类型: object
├─ optionId	string	非必须
├─ optionLabel	string	非必须
├─ optionValue	string	非必须
├─ enabled	boolean	非必须
├─ add	boolean	非必须
├─ required	boolean	非必须
├─ enabled	boolean	非必须
├─ remark	string	非必须
├─ unique	boolean	非必须
├─ modifiable	boolean	非必须
├─ error	null	非必须
├─ selectType	boolean	非必须
├─ dictionaryValues	object []	非必须	item 类型: object
├─ dictionaryUuid	string	非必须
├─ dictionaryValueTransientValue	string	非必须
├─ explainText	string	非必须
├─ type	string	非必须
├─ udAccountDictionaryList	object []	非必须	item 类型: object
├─ dictionaryUuid	string	非必须
├─ createTime	number	非必须
├─ fieldName	string	非必须
├─ fieldValue	string	非必须
├─ type	string	非必须
├─ fieldType	string	非必须
├─ selectFieldOptions	object []	非必须	item 类型: object
├─ optionId	string	非必须
├─ optionLabel	string	非必须
├─ optionValue	string	非必须
├─ enabled	boolean	非必须
├─ add	boolean	非必须
├─ required	boolean	非必须
├─ enabled	boolean	非必须
├─ remark	string	非必须
├─ unique	boolean	非必须
├─ modifiable	boolean	非必须
├─ error	null	非必须
├─ selectType	boolean	非必须
├─ udAccountDictionaryValues	object []	非必须	item 类型: object
├─ dictionaryUuid	string	非必须
├─ dictionaryValueTransientValue	string	非必须
├─ explainText	string	非必须
├─ type	string	非必须
├─ defaultExpireTime	string	非必须
├─ notSelfAccount	boolean	非必须

2.5. 授权¶

2.5.1. 应用授权-账户/组织¶

基本信息

Path： /api/bff/v1.2/ps/app/authorization/update_privilege_entity

Method： POST

接口描述：

主体是指：账户(UD_ACCOUNT)、组(UD_GROUP)、组织机构(ORGANIZATION_UNIT)、分类(ATTRIBUTE_CLASS)
客体是指：应用、角色、权限资源
此处应用授权-账户/组织，则主体类型是账户（UD_ACCOUNT）和组织（ORGANIZATION_UNIT）
客体类型是应用（APPLICATION_INFORMATION）

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	其他信息
privilegeUuid	string	必须	客体uuid 此处为应用uuid
privilegeType	string	必须	客体类型，此处为应用
privilegePSSystemUuid	string	必须	IDaaS默认权限系统uuid
forwardAddEntityUuidCollection	object []	必须	正向授权
├─ entityType	string	必须	主体类型，此处为账户或组织
├─ entityUuid	string	必须	主体uuid,此处为账户或者组织uuid
├─ checkStatus	string	必须	默认值ALLOW
├─ defaultCheckStatus	string	必须	默认值NULL
├─ psSystemUuid	string	必须	IDaaS默认权限系统uuid
├─ authorizations	object []	必须	item 类型: object
├─ entityUuid	string	必须	主体uuid,此处为账户或者组织uuid
forwardRemoveEntityUuidCollection	string []	非必须	item 类型: string
reverseAddEntityUuidCollection	string []	非必须	item 类型: string
reverseRemoveEntityUuidCollection	string []	非必须	item 类型: string
clientToken	string	非必须

Body数据示例(账户)

{
  "privilegeUuid": "b24caae37723ebe7e8789f26f21e3a6ddahM7CnbSLx",
  "privilegeType": "APPLICATION_INFORMATION",
  "privilegePSSystemUuid": "915a723d4b58131b96427ca5a23c6378tZzHUWOrLcn",
  "forwardAddEntityUuidCollection": [
    {
      "entityType": "UD_ACCOUNT",
      "entityUuid": "fe70a486b38800f485f61cd58806e947K4WBhSRSrhm",
      "checkStatus": "ALLOW",
      "defaultCheckStatus": "NULL",
      "psSystemUuid": "915a723d4b58131b96427ca5a23c6378tZzHUWOrLcn",
      "authorizations": [
        {
          "entityUuid": "fe70a486b38800f485f61cd58806e947K4WBhSRSrhm"
        }
      ]
    }
  ],
  "forwardRemoveEntityUuidCollection": [],
  "reverseAddEntityUuidCollection": [],
  "reverseRemoveEntityUuidCollection": [],
  "clientToken": "h78cq6idw2r00kmg"
}

Body数据示例(组织)

{
  "privilegeUuid": "b24caae37723ebe7e8789f26f21e3a6ddahM7CnbSLx",
  "privilegeType": "APPLICATION_INFORMATION",
  "privilegePSSystemUuid": "915a723d4b58131b96427ca5a23c6378tZzHUWOrLcn",
  "forwardAddEntityUuidCollection": [
    {
      "entityType": "ORGANIZATION_UNIT",
      "entityUuid": "6475ece06d774e44a2c79f683560e0aamuyqN61gFR8",
      "psSystemUuid": "915a723d4b58131b96427ca5a23c6378tZzHUWOrLcn",
      "authorizations": [
        {
          "entityUuid": "6475ece06d774e44a2c79f683560e0aamuyqN61gFR8",
          "condition": {},
          "ipAuth": {}
        }
      ]
    }
  ],
  "forwardRemoveEntityUuidCollection": [],
  "reverseAddEntityUuidCollection": [],
  "reverseRemoveEntityUuidCollection": [],
  "clientToken": "mrp9lv73fugc7w6t"
}

返回数据

名称	类型	是否必须
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	null	非必须

返回数据示例

{
  "success": true,
  "code": "200",
  "message": null,
  "requestId": "1634198365547$15aa610f-c2c9-308d-af5f-ef107fa16063",
  "data": null
}

2.6. 审计¶

2.6.1. 查询操作日志¶

基本信息

Path： /api/bff/v1.2/audit/enterprise/audit/list

Method： POST

接口描述：

获取审计日志列表，支持分页查询，高级筛选等

请求参数

Query

参数名称	是否必须	示例	备注
currentPage	否	1	当前页
dateType	否	custom
startTime	否	1723132800000	开始日期
endTime	否	1725897599999	结束日期
eventTypes	否	[]	事件类型
logType	否	USER	日志类型
paramsType	否	username	搜索类型
paramsValue	否	test	搜索值
advancedFiltering	否	object	高级搜索列表
├─ advancedLogic	否	AND	高级搜索查询逻辑
├─ advancedFilters	否	object[]	高级搜索列表
├─ fieldValue	否	event_type	字段值
├─ condition	否	in	查询条件
├─ fieldAttribute	否		字段属性值
├─ values	否	[“value1”,“value2”]	查询值

返回数据

名称	类型	是否必须	其他信息
success	boolean	非必须
code	string	非必须
message	null	非必须
requestId	string	非必须
data	object	非必须
├─ totalCount	long	非必须
├─ data	object[]	非必须	item类型：object

返回示例

{
    "success": true,
    "code": "200",
    "message": null,
    "requestId": "Ignored_Trace",
    "data": {
        "totalCount": 87,
        "data": [
          {
                "context": {
                    "actor": {
                        "actorId": "042665cf4f8e53c2c8934c06xxx98712K2L0Lmsxxxx",
                        "type": "urn:alibaba:idaas:actortype:idaas:user",
                        "typeString": "用户",
                        "name": "xxxx"
                    },
                    "environment": {
                        "ip": "127.0.0.1",
                        "device": "Unknown",
                        "operationSystem": "Windows 10",
                        "browser": "Chrome",
                        "via": "urn:alibaba:idaas:log:via:login",
                        "type": "urn:alibaba:idaas:log:type:user"
                    }
                }
            }
        ]
    }
}

返回上级

自定义IT控制台¶

1. 什么是自定义IT控制台¶

2. 控制台API概览¶

2.1. 用户认证¶

2.1.1. 登录接口¶

2.1.1.1. 前端登录时预加载一些信息(如 是否显示验证码)¶

2.1.1.2. 获取图片验证码¶

2.1.1.3. 获取SM2的公钥与code¶

2.1.1.4. 前端登录,REST¶

2.1.1.5. 接口使用注意事项¶

2.1.2. 注册接口¶

2.1.3. 密码修改¶

2.1.4. 查询登录用户信息¶

2.1.5. 查询登录用户详细信息¶

2.1.6. 登出接口¶

2.2. 登录后令牌上传说明¶

2.3. 应用管理¶

2.3.1. 新建JWT应用¶

2.3.1.1. 新建JWT-加载schema¶

2.3.1.2. 新建JWT-加载信息¶

2.3.1.3. 新建JWT-提交表单¶

2.3.2. 新建OAuth2应用¶

2.3.2.1. 新建OAuth2-加载schema¶

2.3.2.2. 新建OAuth2-加载信息¶

2.3.2.3. 新建OAuth2-提交表单¶

2.3.3. 修改JWT应用¶

2.3.3.1. 修改JWT-加载信息¶

2.3.3.2. 修改JWT-保存数据¶

2.3.4. 修改OAuth2应用¶

2.3.4.1. 修改OAuth2-加载信息¶

2.3.4.2. 修改OAuth2-保存数据¶

2.3.5. 下线应用¶

2.3.6. 上线应用¶

2.3.7. 应用列表¶

2.3.8. 删除应用¶

2.4. 用户目录¶

2.4.1. 新建组织机构¶

2.4.2. 修改组织机构¶

2.4.3. 删除组织机构¶

2.4.4. 查询单个组织机构¶

2.4.5. 查询根组织机构¶

2.4.6. 查询组织下一级组织机构¶

2.4.7. 查询某组织下组织机构列表¶

2.4.8. 查询组织下直属账户列表¶

2.4.9. 新建组¶

2.4.10. 修改组¶

2.4.11. 删除组¶

2.4.12. 查询单个组¶

2.4.13. 查询组列表¶

2.4.14. 组添加成员¶

2.4.15. 组移除成员¶

2.4.16. 组成员查询¶

2.4.17. 账户列表¶

2.4.18. 新建账户¶

2.4.19. 修改账户¶

2.4.20. 删除账户¶

2.4.21. 查询单个账户¶

2.5. 授权¶

2.5.1. 应用授权-账户/组织¶

2.6. 审计¶

2.6.1. 查询操作日志¶

2.1.1.1. 前端登录时预加载一些信息(如是否显示验证码)¶