API参考

概述

目的

IDaaS REST接口可以很方便的对统一身份管理的资源进行管理。

本文档描述了统一身份管理IDaaS产品对外提供的所有API(REST)接口，方便开发者查询和二次开发。

使用对象

该文档是统一身份管理IDaaS产品的API(REST)手册。

该文档使用对象为：使用统一身份管理IDaaS产品的开发人员。

术语定义

IDaaS：IDaaS是Inspur Identity as a Service的简称，中文名称为统一身份管理，是浪潮云的应用身份管理服务，提供集中式的身份管理、授权、认证、访问控制、审计等功能，确保政府和企业用户根据权限访问浪潮云、其他云和本地应用系统，并对用户的异常操作行为进行主动防范。

应用：指所要接入IDaaS的应用。

回调链接：用户通过认证地址校验通过后回调的地址。

资源：用户抽象出来的一切资源，比如数据、API、菜单、按钮等。

操作类型：为资源定义操作（动词形式），例如：read。每一项都是 [资源:操作] 的形式。

REST：Representational State Transfer，简称REST，即表现层状态转化，是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。它是一种针对网络应用的设计和开发方式，可以降低开发的复杂性，提高系统的可伸缩性。

API定义

1.除非特殊说明，所有接口都需传 token

2.响应默认包含 "code" "message" "data" "status" ，部分响应示例可能省略

3.如出现请求路径、请求参数与请求示例不一致的情况，以小标题“URL”内容为准

组织机构

删除组织机构

基本信息

Path： /idaas/v1/organs/{organId}

Method： DELETE

接口描述：

有子组织时禁止删除

请求参数

Headers

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

路径参数

参数名称	示例	备注
organId	E62BD50388ED4DE2A63D6A8D9AA3A560	组织结构Id

返回数据

{
    "code": "200",
    "message": "ok",
    "data": {
        "id": "E62BD50388ED4DE2A63D6A8D9AA3A560",
        "externalId": "kuwdh",
        "code": "test",
        "name": "test01",
        "type": "1",
        "description": "akwkhdh",
        "order": 1,
        "parentId": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
        "isLeaf": "1",
        "creator": "dev",
        "status": "0",
        "createdTime": "2021-08-10 17:01:50",
        "updatedTime": "2021-08-10 17:01:50",
        "a5tId": null
    },
    "status": 200,
    "requestId": ""
}

启用/禁用组织机构

基本信息

Path： /idaas/v1/organs/{organId}/action/change-status

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
organId	B58F327FB2854FFA91110545CA2EC39D	组织机构Id

Query

参数名称	是否必须	示例	备注
status	是	1	启用-1 禁用 -2

返回数据

{
    "code": "200",
    "message": "ok",
    "data": "2",
    "status": 200,
    "requestId": ""
}

新增/修改组织机构

基本信息

Path： /idaas/v1/organs

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
name	string	必须	名称，新增必传，修改可选
parentId	string	必须	父节点id，根节点传空或-1。新增必传，不可修改
externalId	string	非必须	外部id，选填，不可修改
description	string	非必须	描述/备注
code	string	必须	编码，新增必传，修改可选
order	number	非必须	显示顺序
id	string	非必须	新建不传，修改必传

返回数据

{
    "code": "200",
    "message": "成功",
    "data": {
        "id": "B58F327FB2854FFA91110545CA2EC39D",
        "externalId": "A6C2E3778F774356A11680389848EBF7",
        "code": "IDaas",
        "name": "哈哈",
        "type": "1",
        "path": null,
        "description": null,
        "order": null,
        "parentId": "-1",
        "regionCode": null,
        "regionName": null,
        "isLeaf": "0",
        "creator": "dev",
        "status": "1",
        "createdTime": "2021-08-11 16:41:19",
        "updatedTime": "2021-08-12 15:49:03",
        "a5tId": null
    },
    "status": 200,
    "requestId": ""
}

查询当前组织机构的子组织分页列表

基本信息

Path： /idaas/v1/organs/{organId}/sub-organs/page/{pageNo}/{pageSize}

Method： GET

接口描述：

分页列表，table中使用，显示已禁用组织

请求参数

路径参数

参数名称	示例	备注
organId	97D5C15533EE48CB8BBCEB6ABD9C6B48	组织Id
pageNo	1	当前页码
pageSize	10	每页中子组织条数

Query

参数名称	是否必须	示例	备注
name	否		搜索条件

返回数据

{
    "code": "200",
    "message": "ok",
    "data": {
        "code": 1,
        "msg": null,
        "pageNo": 1,
        "pageSize": 10,
        "totalCount": 0,
        "pages": 0,
        "data": [
            {
                "id": "E62BD50388ED4DE2A63D6A8D9AA3A560",
                "externalId": null,
                "code": null,
                "name": "test01",
                "type": null,
                "description": null,
                "order": 1,
                "parentId": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
                "isLeaf": "1",
                "creator": null,
                "status": "1",
                "createdTime": "2021-08-10 17:01:50",
                "updatedTime": "2021-08-10 17:01:50",
                "a5tId": null
            },
            {
                "id": "431C145809AE4A54904DCCC09B4454A6",
                "externalId": null,
                "code": null,
                "name": "testfunction22",
                "type": null,
                "description": null,
                "order": 3,
                "parentId": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
                "isLeaf": "1",
                "creator": null,
                "status": "1",
                "createdTime": "2021-08-10 16:51:34",
                "updatedTime": "2021-08-10 16:51:34",
                "a5tId": null
            }
        ]
    },
    "status": 200,
    "requestId": ""
}

查询当前组织机构的子组织列表（不分页）

基本信息

Path： /idaas/v1/organs/{organId}/sub-organs/list

Method： GET

接口描述：

树状图使用，禁用组织结构不显示

请求参数

路径参数

参数名称	示例	备注
organId	97D5C15533EE48CB8BBCEB6ABD9C6B48	组织机构id

返回数据

{
    "code": "200",
    "message": "ok",
    "data": [
        {
            "id": "E62BD50388ED4DE2A63D6A8D9AA3A560",
            "externalId": "kuwdh",
            "code": "test",
            "name": "test01",
            "type": "1",
            "description": "akwkhdh",
            "order": 1,
            "parentId": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
            "isLeaf": "1",
            "creator": "dev",
            "status": "1",
            "createdTime": "2021-08-10 17:01:50",
            "updatedTime": "2021-08-10 17:01:50",
            "a5tId": null
        },
        {
            "id": "431C145809AE4A54904DCCC09B4454A6",
            "externalId": "B502EC8976D04F22B39936F1C9D7A664",
            "code": null,
            "name": "testfunction22",
            "type": "1",
            "description": "",
            "order": 3,
            "parentId": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
            "isLeaf": "1",
            "creator": "dev",
            "status": "1",
            "createdTime": "2021-08-10 16:51:34",
            "updatedTime": "2021-08-10 16:51:34",
            "a5tId": null
        }
    ],
    "status": 200,
    "requestId": ""
}

查询组织机构详情

基本信息

Path： /idaas/v1/organs/{organId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
organId	97D5C15533EE48CB8BBCEB6ABD9C6B48	组织机构id

返回数据

{
    "code": "200",
    "message": "ok",
    "data": {
        "id": "B58F327FB2854FFA91110545CA2EC39D",
        "externalId": "A6C2E3778F774356A11680389848EBF7",
        "code": "IDaas",
        "name": "哈哈",
        "type": "1",
        "path": "/哈哈",
        "description": null,
        "order": null,
        "parentId": "-1",
        "regionCode": null,
        "regionName": null,
        "isLeaf": "0",
        "creator": "dev",
        "status": "1",
        "createdTime": "2021-08-11 16:41:19",
        "updatedTime": "2021-08-12 15:49:03",
        "a5tId": null
    },
    "status": 200,
    "requestId": ""
}

移动组织机构

基本信息

Path： /idaas/v1/organs/action/move

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须		当前组织机构id
parentId	string	必须		父节点id

返回数据

{
    "code": "200",
    "message": "ok",
    "data": {
        "id": "E62BD50388ED4DE2A63D6A8D9AA3A560",
        "externalId": "kuwdh",
        "code": "test",
        "name": "test01",
        "type": "1",
        "description": "akwkhdh",
        "order": 1,
        "parentId": "9a4a9c443cdc4ad7a931a21563bd940e",
        "isLeaf": "1",
        "creator": "dev",
        "status": "1",
        "createdTime": "2021-08-10 17:01:50",
        "updatedTime": "2021-08-10 17:01:50",
        "a5tId": null
    },
    "status": 200,
    "requestId": ""
}

组织机构授权/取消授权应用

基本信息

Path： /idaas/v1/organs/{organId}/action/auth

Method： POST

接口描述：

{
    "appIdList":[
        "3D798BAE694044CAA08D954A85837313",
        "58A0B2F7A51B44039F4B4F186F4747FB",
        "78A49CACB9D84B579B739E1C61EA28DD"
    ],
"action":"auth"
}

请求参数

Headers

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

路径参数

参数名称	示例	备注
organId		组织机构Id

Body

名称	类型	是否必须	备注	其他信息
appIdList	string []	必须		item 类型: string
├─		非必须
action	string	必须	auth-授权 unauth-取消授权

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

获取应用可授权/已授权的组织机构分页列表

基本信息

Path： /idaas/v1/organs/auth-app/{appId}/page/{pageNo}/{pageSize}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appId	1F2872723B834FCF9D429930252FB2AF	应用id
pageNo	1	当前页码
pageSize	10	每页中子组织机构条数

Body

名称	类型	是否必须	默认值	备注	其他信息
type	string	必须		需要查询的组织机构类型 1-可以授权的 2-已授权的
name	string	非必须		组织机构名称，支持模糊查询

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 10,
      "totalCount": 0,
      "pages": 0,
      "data": [
         {
            "path": "/IDaas/sss",
            "code": "asas11",
            "parent_id": "93FDFB9B4AE44FDBBA841FEC2A331405",
            "name": "sss",
            "description": "sadasd",
            "id": "2DE4532F64FD4A38A8B208B8850B45E3",
            "is_leaf": "1",
            "order": 1
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

验证外部Id是否可用

基本信息

Path： /idaas/v1/organs/action/verify-externalId

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
organId	string	非必须		新建时可空，修改时必填
erternalId	string	必须

返回数据

{
    "code": "200",
    "message": "ok",
    "data": true,
    "status": 200,
    "requestId": ""
}

验证编码是否可用

基本信息

Path： /idaas/v1/organs/action/verify-code

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
organId	string	非必须		新建可空，修改必传
code	string	必须		code

返回数据

{
    "code": "200",
    "message": "ok",
    "data": true,
    "status": 200,
    "requestId": ""
}

主题管理

获取登录主题列表(不分页)

基本信息

Path： /idaas/v1/logintheme/listthemes

Method： GET

接口描述：

请求参数

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "007998CEB4A4428FBE6EA9DE9D41BE4F",
         "themeName": "yunzhou-smart",
         "createdTime": "2021-09-16 16:14:29",
         "updatedTime": "2021-09-16 16:14:29",
         "creator": "inspurtest06"
      },
      {
         "id": "07263257F8E442C7AE36B18B97D2D5BA",
         "themeName": "inspurcloudv3-connect-test",
         "createdTime": "2021-09-16 16:13:26",
         "updatedTime": "2021-09-16 16:13:26",
         "creator": "inspurtest06"
      },
      {
         "id": "08B3CDA9B03740D38AC3B50AFBBA5ED4",
         "themeName": "inspurcloudv3-connect",
         "createdTime": "2021-09-16 16:12:23",
         "updatedTime": "2021-09-16 16:12:23",
         "creator": "inspurtest06"
      },
      {
         "id": "1086136390EB40228684837E3EF91376",
         "themeName": "industrial-internet-connect-lb",
         "createdTime": "2021-09-16 16:10:21",
         "updatedTime": "2021-09-16 16:10:21",
         "creator": "inspurtest06"
      },
      {
         "id": "1CF7DF08732644BA8D28456D5706BA1F",
         "themeName": "inspur",
         "createdTime": "2021-09-16 16:10:48",
         "updatedTime": "2021-09-16 16:10:48",
         "creator": "inspurtest06"
      },
      {
         "id": "1FD219FFC7BC4EEF93300710DEB49FBB",
         "themeName": "zunyi",
         "createdTime": "2021-09-16 16:14:42",
         "updatedTime": "2021-09-16 16:14:42",
         "creator": "inspurtest06"
      },
      {
         "id": "3938E2DB075E445681C868C8F3EFEAED",
         "themeName": "ccssv1",
         "createdTime": "2021-09-16 16:07:05",
         "updatedTime": "2021-09-16 16:07:05",
         "creator": "inspurtest06"
      },
      {
         "id": "41DFFA02E6BC485384C07E897BA7421D",
         "themeName": "gov-public",
         "createdTime": "2021-09-16 16:09:38",
         "updatedTime": "2021-09-16 16:09:38",
         "creator": "inspurtest06"
      },
      {
         "id": "42098E29AE084D84A408FCE2C811DE34",
         "themeName": "picpv3",
         "createdTime": "2021-09-16 16:14:04",
         "updatedTime": "2021-09-16 16:14:04",
         "creator": "inspurtest06"
      },
      {
         "id": "53F8F9803066419E84B4330357E0CBEB",
         "themeName": "inspurcloudv3",
         "createdTime": "2021-09-16 16:12:10",
         "updatedTime": "2021-09-16 16:12:10",
         "creator": "inspurtest06"
      },
      {
         "id": "5A96152D518F491198A2527F60D7872D",
         "themeName": "industrial-internet-connect-gx",
         "createdTime": "2021-09-16 16:10:05",
         "updatedTime": "2021-09-16 16:10:05",
         "creator": "inspurtest06"
      },
      {
         "id": "6FE4483EF877462BA93067E5259BF669",
         "themeName": "industrial-internet-connect",
         "createdTime": "2021-09-16 16:09:53",
         "updatedTime": "2021-09-16 16:09:53",
         "creator": "inspurtest06"
      },
      {
         "id": "74914D1FCA90400AADB60076E2B4AE3A",
         "themeName": "chongqingzhengxin",
         "createdTime": "2021-09-16 16:08:31",
         "updatedTime": "2021-09-16 16:08:31",
         "creator": "inspurtest06"
      },
      {
         "id": "7A763F5E839047419D6FB0A1EACB27F5",
         "themeName": "yunzhou",
         "createdTime": "2021-09-16 16:14:17",
         "updatedTime": "2021-09-16 16:14:17",
         "creator": "inspurtest06"
      },
      {
         "id": "7BE697E464BB487B9416BF5D7861A89B",
         "themeName": "inspurcloud-oss",
         "createdTime": "2021-09-16 16:11:55",
         "updatedTime": "2021-09-16 16:11:55",
         "creator": "inspurtest06"
      },
      {
         "id": "7F51678A45974F52A4D6DE9D5A65BFE9",
         "themeName": "inspurcloudv3-connect-dev",
         "createdTime": "2021-09-16 16:12:36",
         "updatedTime": "2021-09-16 16:12:36",
         "creator": "inspurtest06"
      },
      {
         "id": "7F8CF23750A7471C97B408761475D9C1",
         "themeName": "inspurcloud-bss",
         "createdTime": "2021-09-16 16:11:28",
         "updatedTime": "2021-09-16 16:11:28",
         "creator": "inspurtest06"
      },
      {
         "id": "87691BCE3FDA4EEFA9241DA68175E588",
         "themeName": "gov-common",
         "createdTime": "2021-09-16 16:09:10",
         "updatedTime": "2021-09-16 16:09:10",
         "creator": "inspurtest06"
      },
      {
         "id": "899545EE35C34010AFD4571FC107B27E",
         "themeName": "linyi-guotu",
         "createdTime": "2021-09-16 16:13:50",
         "updatedTime": "2021-09-16 16:13:50",
         "creator": "inspurtest06"
      },
      {
         "id": "9F4F72668F6A40EC98514082BCD8141F",
         "themeName": "gly",
         "createdTime": "2021-09-16 16:08:56",
         "updatedTime": "2021-09-16 16:08:56",
         "creator": "inspurtest06"
      },
      {
         "id": "A7CF2FA4E7F549E994FDFF52C92FFB69",
         "themeName": "inspurcloudv3-hk",
         "createdTime": "2021-09-16 16:13:38",
         "updatedTime": "2021-09-16 16:13:38",
         "creator": "inspurtest06"
      },
      {
         "id": "BC25382723234B0DB4C3A235ED43A5B1",
         "themeName": "inspurcloudv3-connect-stage",
         "createdTime": "2021-09-16 16:13:13",
         "updatedTime": "2021-09-16 16:13:13",
         "creator": "inspurtest06"
      },
      {
         "id": "C76A3D9B43CE4F689724835507BEB4A6",
         "themeName": "devops",
         "createdTime": "2021-09-16 16:08:45",
         "updatedTime": "2021-09-16 16:08:45",
         "creator": "inspurtest06"
      },
      {
         "id": "C9A7E36C10CE429DB04FCA35B51C1FBE",
         "themeName": "ccssv1staging",
         "createdTime": "2021-09-16 16:08:01",
         "updatedTime": "2021-09-16 16:08:01",
         "creator": "inspurtest06"
      },
      {
         "id": "CCEFF6A6BA334B14ADFC098657489431",
         "themeName": "inspurcloudv3-connect-dynamic",
         "createdTime": "2021-09-16 16:12:49",
         "updatedTime": "2021-09-16 16:12:49",
         "creator": "inspurtest06"
      },
      {
         "id": "CD5C2C18682F48D7AB3311023F2A02CF",
         "themeName": "inspurcloud-boss",
         "createdTime": "2021-09-16 16:11:14",
         "updatedTime": "2021-09-16 16:11:14",
         "creator": "inspurtest06"
      },
      {
         "id": "CDE6F31F67304C28B0E717681976C26B",
         "themeName": "inspurcloud-bss-dynamic",
         "createdTime": "2021-09-16 16:11:41",
         "updatedTime": "2021-09-16 16:11:41",
         "creator": "inspurtest06"
      },
      {
         "id": "EDC7DC870DA04F96806D8E5076845680",
         "themeName": "gov-platform",
         "createdTime": "2021-09-16 16:09:24",
         "updatedTime": "2021-09-16 16:09:24",
         "creator": "inspurtest06"
      },
      {
         "id": "F490A4382FAD46229C7A5067A953CEC3",
         "themeName": "ccssv1dev",
         "createdTime": "2021-09-16 16:07:47",
         "updatedTime": "2021-09-16 16:07:47",
         "creator": "inspurtest06"
      },
      {
         "id": "F6B97196F0714320BEB4DFD08316784E",
         "themeName": "inspurcloud",
         "createdTime": "2021-09-16 16:10:59",
         "updatedTime": "2021-09-16 16:10:59",
         "creator": "inspurtest06"
      },
      {
         "id": "F6DF476AF3A344B6911C20D683364FFC",
         "themeName": "inspurcloudv3-connect-gov",
         "createdTime": "2021-09-16 16:13:01",
         "updatedTime": "2021-09-16 16:13:01",
         "creator": "inspurtest06"
      },
      {
         "id": "FBA52E4BE66C4D259684588849A6CB98",
         "themeName": "industrial-internet-connect-zjk",
         "createdTime": "2021-09-16 16:10:34",
         "updatedTime": "2021-09-16 16:10:34",
         "creator": "inspurtest06"
      },
      {
         "id": "FC71328FA9A14F90831394BC4EE0D90D",
         "themeName": "ccssv1test",
         "createdTime": "2021-09-16 16:08:16",
         "updatedTime": "2021-09-16 16:08:16",
         "creator": "inspurtest06"
      }
   ],
   "status": 200,
   "requestId": ""
}

扩展字段—字典管理

删除扩展字段

基本信息

Path： /idaas/v1/extendedfields/{id}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id	C90AF9DE874F4A38880305B9AD174347	扩展字段id

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "C90AF9DE874F4A38880305B9AD174347",
      "fieldName": "extend_col_1",
      "fieldValue": "extend_col_111",
      "fieldClassification": "0",
      "fieldType": "0",
      "isRequired": "1",
      "isEditable": "1",
      "isUnique": "1",
      "fieldStatus": "1",
      "description": "extend_col_111",
      "createdTime": "2021-09-21 15:54:23",
      "updatedTime": "2021-09-23 19:57:40",
      "creator": "inspurtest06"
   },
   "status": 200,
   "requestId": ""
}

启用状态扩展字段列表(不分页)

基本信息

Path： /idaas/v1/extendedfields/listfields

Method： GET

接口描述：

请求参数

Query

参数名称	是否必须	示例	备注
fieldClassification	是	2	0-用户 1-组 2-组织机构

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "fieldName": "qqq",
         "fieldStatus": "1",
         "description": "",
         "id": "ED9D479A13F74842AE3259E126967483",
         "fieldClassification": "2",
         "fieldType": "0"
      },
      {
         "fieldName": "habit",
         "fieldStatus": "1",
         "description": "qq",
         "id": "D48849CA502D4ACE8D856D0687E530B0",
         "fieldClassification": "2",
         "fieldType": "0"
      },
      {
         "fieldName": "sentence",
         "fieldStatus": "1",
         "description": "",
         "id": "40170311700546088D546B3D9B93E013",
         "fieldClassification": "2",
         "fieldType": "2"
      },
      {
         "fieldName": "age",
         "fieldStatus": "1",
         "description": "qq",
         "id": "021796A7583C418BA7DF75899A2DEF2F",
         "fieldClassification": "2",
         "fieldType": "1"
      },
      {
         "fieldName": "name",
         "fieldStatus": "1",
         "description": "name1111",
         "id": "770817093CF94E298A30E8DC244C4ED6",
         "fieldClassification": "2",
         "fieldType": "1"
      }
   ],
   "status": 200,
   "requestId": ""
}

新增扩展字段

基本信息

Path： /idaas/v1/extendedfields

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "fieldName": "extend_col_3",
   "fieldValue": "extend_col_3",
   "fieldClassification": 0,
   "fieldType": 1,
   "isRequired": 1,
   "isEditable": 1,
   "isUnique": 0,
   "fieldStatus": 1,
   "description": "extend_col_3"
}

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "9F5D94F733154801986AFE5A044251A5",
      "fieldName": "extend_col_3",
      "fieldValue": "extend_col_3",
      "fieldClassification": "0",
      "fieldType": "1",
      "isRequired": "1",
      "isEditable": "1",
      "isUnique": "0",
      "fieldStatus": "1",
      "description": "extend_col_3",
      "createdTime": "2021-09-21 16:32:53",
      "updatedTime": "2021-09-21 16:32:53",
      "creator": "inspurtest06"
   },
   "status": 200,
   "requestId": ""
}

更新扩展字段

基本信息

Path： /idaas/v1/extendedfields/updateExtendedField

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "id": "C90AF9DE874F4A38880305B9AD174347",
   "fieldName": "extend_col_111",
   "fieldValue": "extend_col_111",
   "isRequired": 1,
   "isEditable": 1,
   "isUnique": 0,
   "fieldStatus": 1,
   "description": "extend_col_111"
}

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "C90AF9DE874F4A38880305B9AD174347",
      "fieldName": "extend_col_111",
      "fieldValue": "extend_col_111",
      "fieldClassification": "0",
      "fieldType": "0",
      "isRequired": "1",
      "isEditable": "1",
      "isUnique": "0",
      "fieldStatus": "1",
      "description": "extend_col_111",
      "createdTime": "2021-09-21 15:54:23",
      "updatedTime": "2021-09-21 16:59:46",
      "creator": "inspurtest06"
   },
   "status": 200,
   "requestId": ""
}

查询扩展字段分页列表

基本信息

Path： /idaas/v1/extendedfields/listextendedfields/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1
pageSize	3

Query

参数名称	是否必须	示例	备注
fieldName	否	extend_col
fieldClassification	否	1	所属分类 0-用户,1-组，2-组织机构

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 4,
      "totalCount": 1,
      "pages": 1,
      "data": [
         {
            "fieldName": "extend_col_4",
            "fieldStatus": "1",
            "description": "extend_col_4",
            "id": "481C9F8DB9E04939814265468AF40B93",
            "fieldClassification": "1",
            "fieldType": "1"
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

根据ID查询扩展字段

基本信息

Path： /idaas/v1/extendedfields//{fieldId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
fieldId	C90AF9DE874F4A38880305B9AD174347

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "C90AF9DE874F4A38880305B9AD174347",
      "fieldName": "extend_col_1",
      "fieldValue": "extend_col_1",
      "fieldClassification": "0",
      "fieldType": "0",
      "isRequired": "1",
      "isEditable": "1",
      "isUnique": "1",
      "fieldStatus": "1",
      "description": "extend_col_1",
      "createdTime": "2021-09-21 15:54:23",
      "updatedTime": "2021-09-21 15:54:23",
      "creator": "inspurtest06"
   },
   "status": 200,
   "requestId": ""
}

验证同一类别 (class)扩展字段是否重名

基本信息

Path： /idaas/v1/extendedfields/{class}/action/verify-fieldname/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
class	0	0-用户/1-组/2-组织机构
name	extend_col_1

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

扩展字段—下拉选项

批量新增下拉选项

基本信息

Path： /idaas/v1/dropdownlist/batch

Method： POST

接口描述：

请求参数

Headers

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

Body

[
   {
      "extendedFieldId": "D48849CA502D4ACE8D856D0687E530B0",
      "fieldName": "habit",
      "label": "越南",
      "value": "越南",
      "status": 1
   },
   {
      "extendedFieldId": "D48849CA502D4ACE8D856D0687E530B0",
      "fieldName": "habit",
      "label": "印度",
      "value": "印度",
      "status": 1
   }
]

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "D1788805E38A4E18A0EFA67BB3229DB4",
         "extendedFieldId": "D48849CA502D4ACE8D856D0687E530B0",
         "fieldName": "habit",
         "label": "越南",
         "value": "越南",
         "status": "1"
      },
      {
         "id": "77F0CA3BE9D64C2CB54E39D8015BC800",
         "extendedFieldId": "D48849CA502D4ACE8D856D0687E530B0",
         "fieldName": "habit",
         "label": "印度",
         "value": "印度",
         "status": "1"
      }
   ],
   "status": 200,
   "requestId": ""
}

新增下拉选项

基本信息

Path： /idaas/v1/dropdownlist

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "5ACAD28D191B4C8E9EF74EE7AEDCBECD",
      "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
      "fieldName": "extend_col_1",
      "label": "加拿大",
      "value": "加拿大",
      "status": "1"
   },
   "status": 200,
   "requestId": ""
}

返回数据

{
   "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
   "fieldName": "extend_col_1",
   "label": "加拿大",
   "value": "加拿大",
   "status": 1
}

更新下拉选项启用状态

基本信息

Path： /idaas/v1/dropdownlist/update

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "id": "C84B3BAF7CD24C9CAE2DE4A0A80F0FDD",
   "status": 1
}

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "C84B3BAF7CD24C9CAE2DE4A0A80F0FDD",
      "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
      "fieldName": "extend_col_1",
      "label": "俄罗斯",
      "value": "俄罗斯",
      "status": "1"
   },
   "status": 200,
   "requestId": ""
}

根据扩展字段ID查询所有下拉选项

基本信息

Path： /idaas/v1/dropdownlist/{listId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
listId	C90AF9DE874F4A38880305B9AD174347

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "4FBD5DF3358249BDBC69F68E1CB12BCD",
         "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
         "fieldName": "extend_col_1",
         "label": "中国",
         "value": "中国",
         "status": "1"
      },
      {
         "id": "5ACAD28D191B4C8E9EF74EE7AEDCBECD",
         "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
         "fieldName": "extend_col_1",
         "label": "加拿大",
         "value": "加拿大",
         "status": "1"
      },
      {
         "id": "C84B3BAF7CD24C9CAE2DE4A0A80F0FDD",
         "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
         "fieldName": "extend_col_1",
         "label": "俄罗斯",
         "value": "俄罗斯",
         "status": "1"
      }
   ],
   "status": 200,
   "requestId": ""
}

验证下拉菜单选项名是否重复

基本信息

Path： /idaas/v1/dropdownlist/{fieldId}/action/verify-labelname/{name}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
fieldId	C90AF9DE874F4A38880305B9AD174347
name	中国

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

扩展字段—值

批量添加字典值

基本信息

Path： /idaas/v1/fieldvalue/batch

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
	object []	非必须		item 类型: object
├─ externalId	string	必须	用户/组/组织机构 id
├─ fieldClassification	number	必须	0-用户 1-组 2-组织机构
├─ extendedFieldId	string	必须	扩展字段id
├─ fieldType	number	必须	0-下拉框 1-文本框 2-文本域
├─ fieldValue	string	必须	值

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "BC2F04C44AC94877B548C37CC264DEC8",
         "externalId": "2b908cd6-c99c-4c69-a349-afb8edac07f2",
         "fieldClassification": "0",
         "extendedFieldId": "9F5D94F733154801986AFE5A044251A5",
         "fieldType": "1",
         "fieldValue": "文本框字段存放一段文本aaaaaa"
      },
      {
         "id": "89392354160143378BD2CBE860DECD12",
         "externalId": "b3a84cae-8aac-4b17-8740-378ceb653773",
         "fieldClassification": "0",
         "extendedFieldId": "9F5D94F733154801986AFE5A044251A5",
         "fieldType": "1",
         "fieldValue": "文本框字段存放一段文本bbbbbb"
      }
   ],
   "status": 200,
   "requestId": ""
}

新增值记录

基本信息

Path： /idaas/v1/fieldvalue

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
externalId	string	必须	用户/组/组织机构 id
fieldClassification	number	必须	0-用户 1-组 2-组织机构
extendedFieldId	string	必须	扩展字段id
fieldType	number	必须	0-下拉框 1-文本框 2-文本域
fieldValue	string	必须	值

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "68D868D6EBF4487EBE960FDABED8B3FB",
      "externalId": "23a65319-f6c9-44a9-8fd4-7cf052a28087",
      "fieldClassification": "0",
      "extendedFieldId": "9F5D94F733154801986AFE5A044251A5",
      "fieldType": "1",
      "fieldValue": "文本框字段存放一段文本"
   },
   "status": 200,
   "requestId": ""
}

更新值

基本信息

Path： /idaas/v1/fieldvalue/update

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "id": "CD938E50450B4F18B7D9DB87DA3153DB",
   "fieldValue": "加拿大"
}

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "CD938E50450B4F18B7D9DB87DA3153DB",
      "externalId": "23a65319-f6c9-44a9-8fd4-7cf052a28087",
      "fieldClassification": "0",
      "fieldName": "extend_col_1",
      "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
      "fieldType": "0",
      "fieldValue": "加拿大"
   },
   "status": 200,
   "requestId": ""
}

根据用户/组/组织 id 批量删除其扩展字段值

基本信息

Path： /idaas/v1/fieldvalue/externalId/{externalId}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
externalId	2b908cd6-c99c-4c69-a349-afb8edac07f2

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "BC2F04C44AC94877B548C37CC264DEC8",
         "externalId": "2b908cd6-c99c-4c69-a349-afb8edac07f2",
         "fieldClassification": "0",
         "extendedFieldId": "9F5D94F733154801986AFE5A044251A5",
         "fieldType": "1",
         "fieldValue": "文本框字段存放一段文本aaaaaa"
      }
   ],
   "status": 200,
   "requestId": ""
}

根据用户/组/组织 id 查询其扩展字段

基本信息

Path： /idaas/v1/fieldvalue/{externalId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
externalId	23a65319-f6c9-44a9-8fd4-7cf052a28087

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "fieldName": "extend_col_111",
         "extendedFieldId": "C90AF9DE874F4A38880305B9AD174347",
         "externalId": "23a65319-f6c9-44a9-8fd4-7cf052a28087",
         "id": "CD938E50450B4F18B7D9DB87DA3153DB",
         "fieldClassification": "0",
         "fieldType": "0",
         "fieldValue": "加拿大"
      },
      {
         "fieldName": "extend_col_3",
         "extendedFieldId": "9F5D94F733154801986AFE5A044251A5",
         "externalId": "23a65319-f6c9-44a9-8fd4-7cf052a28087",
         "id": "68D868D6EBF4487EBE960FDABED8B3FB",
         "fieldClassification": "0",
         "fieldType": "1",
         "fieldValue": "文本框字段存放一段文本"
      }
   ],
   "status": 200,
   "requestId": ""
}

验证某一字段(fieldId)值(value)是否重复

基本信息

Path： /idaas/v1/fieldvalue/{fieldId}/action/verify-value/{value}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
fieldId	C90AF9DE874F4A38880305B9AD174347
value	加拿大

返回数据

{
   "code": "200",
   "message": "ok",
   "data": false,
   "status": 200,
   "requestId": ""
}

账户管理

用户应用列表分页

基本信息

Path： /idaas/v1/user/userAuth/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo
pageSize

Query

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

返回数据

名称	类型	是否必须	其他信息
code	string	非必须
message	string	非必须
data	object	非必须
├─ code	number	非必须
├─ msg	null	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ totalCount	number	非必须
├─ pages	number	非必须
├─ data	object []	非必须	item 类型: object
├─ id	string	必须
├─ userId	string	必须
├─ appAuthflag	string	必须
├─ createdTime	string	必须
├─ updateTime	null	必须
├─ creator	string	必须
├─ appName	null	必须
├─ appStatus	null	必须
status	number	非必须
requestId	string	非必须

用户应用权限删除

基本信息

Path： /idaas/v1/user/delAppAuth

Method： POST

接口描述：

{
"idList":[
"26F0C3C85BDD4E599292CF040338357F"
]

}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
idList	string []	非必须			item 类型: string
├─		非必须		授权记录id，在列表中返回

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	null	非必须
status	number	非必须
requestId	string	非必须

账户修改\密码修改

基本信息

Path： /idaas/v1/user/updateUser

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
accountName	string	非必须
email	string	非必须
phone	string	非必须
nickName	string	非必须
expirationTime	string	非必须
description	string	非必须
externald	string	非必须
organizationId	string	非必须
userType	string	非必须
p6d	string	非必须
id	string	必须	账户id，必传
status	string	非必须	账户状态 0-已删除 1-正常 2-已禁用

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	null	非必须
status	number	非必须
requestId	string	非必须

账户列表获取

基本信息

Path： /idaas/v1/user/page/{pageNo}/{pageSize}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
pageNo
pageSize

Query

参数名称	是否必须	备注
accountName	否	账户名称
organizationId	否	组织id
status	否	状态
userTypeId	否
nickName	否
phone	否
email	否
appId	否	应用id

返回数据

名称	类型	是否必须	备注	其他信息
code	string	非必须
message	string	非必须
data	object	非必须
├─ code	number	非必须
├─ msg	null	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ totalCount	number	非必须
├─ pages	number	非必须
├─ data	object []	非必须		item 类型: object
├─ id	string	必须
├─ email	string	必须
├─ phone	string	必须
├─ p6d	string	必须
├─ createdType	string	必须
├─ nickName	string	必须
├─ expirationTime	string	必须
├─ createdTime	string	必须
├─ updateTime	null	必须
├─ creator	null	必须
├─ a5tId	null	必须
├─ description	string	必须
├─ organizationId	string	必须
├─ status	string	必须
├─ userType	string	必须
├─ accountName	null,string	必须
├─ organName	null	必须
├─ userTypeName	null	必须
├─ idBind	string	必须	是否绑定改应用 0、否 1、是
status	number	非必须
requestId	string	非必须

账户删除（物理删除）

基本信息

Path： /idaas/v1/user/delete

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
idList	string []	必须		用户id列表	item 类型: string
├─		非必须		id项

账户导入excel模板下载

基本信息

Path： /idaas/v1/user/modelDown

Method： GET

接口描述：

请求参数

账户应用授权

基本信息

Path： /idaas/v1/user/addUserAppAuth

Method： POST

接口描述：

{
"userIdList":[
"0A55B234B86B487DB9EA139735AE8C27"
],
"appIdList":[
"123"
]

}

请求参数

Headers

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

Body

名称	类型	是否必须	备注	其他信息
userIdList	string []	非必须		item 类型: string
├─		非必须
appIdList	string []	非必须		item 类型: string
├─		非必须
action	string	必须	auth-授权 unauth-取消授权

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	null	非必须
status	number	非必须
requestId	string	非必须

账户应用查询

基本信息

Path： /idaas/v1/user/userAppAuthList?id=0A55B234B86B487DB9EA139735AE8C27

Method： GET

接口描述：

请求参数

返回数据

名称	类型	是否必须	其他信息
code	string	非必须
message	string	非必须
data	object []	非必须	item 类型: object
├─ id	string	非必须
├─ userId	string	非必须
├─ appAuthflag	string	非必须
├─ createdTime	string	非必须
├─ updateTime	null	非必须
├─ creator	string	非必须
├─ appName	null	非必须
├─ appStatus	null	非必须
status	number	非必须
requestId	string	非必须

账户批量导入

基本信息

Path： /idaas/v1/user/userInfoImport

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	multipart/form-data	是

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	null	非必须
status	number	非必须
requestId	string	非必须

账户新增

基本信息

Path： /idaas/v1/user/createUser

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
accountName	string	必须	账户名称
email	string	非必须	邮箱
phone	string	必须	手机号
nickName	string	必须	显示名称
expirationTime	string	必须	时间选择，过期时间
description	string	非必须	备注
externalId	string	非必须	外部id
organizationId	string	必须	组织id
userType	string	必须	用户类型id
p6d	string	必须	密码

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	null	非必须
status	number	非必须
requestId	string	非必须

账户离职（逻辑删除）

基本信息

Path： /idaas/v1/user/dimission

Method： POST

接口描述：

{
"idList":[
"67A677C87CCC4AF8874BC0BB2839219F",
"677259DE369F4055AE53C80B6B8371DA"
]
}

请求参数

Headers

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

Body

名称	类型	是否必须	默认值	备注	其他信息
idList	string []	必须			item 类型: string
├─		非必须

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	string	非必须
status	number	非必须
requestId	string	非必须

账户移除（移动到根节点）

基本信息

Path： /idaas/v1/user/remove

Method： POST

接口描述：

请求参数

Headers

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

账户详情获取

基本信息

Path： /idaas/v1/user/userInfoDetail?id=4B8D9C24BF8042E6820D39C4F81A4BBE

Method： GET

接口描述：

请求参数

Headers

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

返回数据

名称	类型	是否必须
code	string	非必须
message	string	非必须
data	object	非必须
├─ id	string	非必须
├─ email	string	非必须
├─ phone	string	非必须
├─ p6d	string	非必须
├─ createdType	string	非必须
├─ nickName	string	非必须
├─ expirationTime	string	非必须
├─ createdTime	string	非必须
├─ updateTime	null	非必须
├─ creator	string	非必须
├─ a5tId	null	非必须
├─ description	string	非必须
├─ organizationId	string	非必须
├─ status	string	非必须
├─ userType	null	非必须
├─ accountName	null	非必须
├─ organName	null	非必须
├─ userTypeName	null	非必须
status	number	非必须
requestId	string	非必须

应用管理

App列表不分页

基本信息

Path： /idaas/v1/apps/list

Method： GET

接口描述：

请求参数

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "2B20A7ED5DE24A5EBE8D909B8ADE8A50",
         "appName": "testapp18",
         "appCode": "testapp18",
         "appIcon": "20210824992108181841086821003441",
         "appAuthType": "0",
         "authinfoSyncType": "0",
         "appTypeCode": "应用10",
         "appStatus": "1",
         "appAuthStatus": "0",
         "creator": "dev",
         "a5tId": null,
         "appDeleteFlag": "0",
         "createdTime": "2021-08-18 18:42:01",
         "updatedTime": "2021-08-19 09:35:21",
         "accessTokenTimeout": 7200,
         "refreshTokenTimeout": 604800,
         "redirectUri": "https://www.baidu.com/",
         "homepageUrl": "https://www.baidu.com/"
      },
      {
         "id": "F75567078F464C38B5FF6CF21E0D98F1",
         "appName": "阿里云",
         "appCode": "apphh02_02",
         "appIcon": "20210822992108141059420151005662",
         "appAuthType": "0",
         "authinfoSyncType": "0",
         "appTypeCode": "类别3",
         "appStatus": "1",
         "appAuthStatus": "2",
         "creator": "dev",
         "a5tId": "abcde2",
         "appDeleteFlag": "0",
         "createdTime": "2021-08-13 14:37:16",
         "updatedTime": "2021-08-18 09:41:00",
         "accessTokenTimeout": 720,
         "refreshTokenTimeout": 604,
         "redirectUri": "https://a123",
         "homepageUrl": "https://a"
      }
   ],
   "status": 200,
   "requestId": ""
}

应用授权/取消授权组织机构

基本信息

Path： /idaas/v1/apps/{appId}/action/auth/organs

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appId		应用id

Body

名称	类型	是否必须	备注	其他信息
organIdList	string []	必须	组织机构id列表	item 类型: string
├─		非必须	id项
action	string	必须	auth-授权 unauth-取消授权

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

应用管理App 列表分页展示

基本信息

Path： /idaas/v1/apps/listapps/page/{pageNo}/{pageSize}?appName=aaa

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1	页码
pageSize	10	每页条数

Query

参数名称	是否必须	示例	备注
appName	否	aaa
userId	否

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 10,
      "totalCount": 0,
      "pages": 0,
      "data": [
         {
            "id": "5E2A6ABAC3014E38A234E491D1815E82",
            "appName": "aaa",
            "appCode": "app01",
            "appIcon": "E:/图标/app1.jpg",
            "appAuthType": "0",
            "authinfoSyncType": "0",
            "equipType": "0",
            "appStatus": "1",
            "appAuthStatus": "0",
            "creator": "dev",
            "a5tId": null,
            "appDeleteFlag": null,
            "createdTime": "2021-08-12 15:47:15",
            "updatedTime": "2021-08-12 15:47:15",
            "idBind": "0"
         },
         {
            "id": "4C97979C553A428ABF546CEF5C34D5B0",
            "appName": "aabbccddeeffgghhiiqqq",
            "appCode": "app10",
            "appIcon": "E:/图标/app10.jpg",
            "appAuthType": "0",
            "authinfoSyncType": "0",
            "equipType": "0",
            "appStatus": "1",
            "appAuthStatus": "0",
            "creator": "dev",
            "a5tId": null,
            "appDeleteFlag": null,
            "createdTime": "2021-08-12 15:46:25",
            "updatedTime": "2021-08-12 15:46:25",
            "idBind": "1"
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

应用管理删除Application

基本信息

Path： /idaas/v1/idaas/v1/apps/{appId}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appId	75ac04de35ed4186a42ae2fef90f5989

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "FABFA49C4E8243A2B0FB58E834FB67F3",
      "appName": "aabbccddeeffgghh",
      "appCode": "app9",
      "appIcon": "E:/图标/app9.jpg",
      "appAuthType": "0",
      "authinfoSyncType": "0",
      "equipType": "0",
      "appStatus": "1",
      "appAuthStatus": "0",
      "creator": "dev",
      "accountId": "abcde",
      "appDeleteFlag": "1",
      "createdTime": "2021-08-12 09:15:29",
      "updatedTime": "2021-08-12 09:15:29"
   },
   "status": 200,
   "requestId": ""
}

应用管理新增Application

基本信息

Path： /idaas/v1/idaas/v1/apps

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "appName": "路况实时监测v10",
   "a5tId": "35237973-1071-43dd-9ac5-852f98758ef8",
   "appCode": "traffic_recognitionv10",
   "description": "traffic recognitionv10",
   "authinfoSyncType": 0,
   "appAuthType": 0,
   "appStatus": 1,
   "appAuthStatus": 1,
   "redirectUri": "https://www.baidu.com/",
   "homepageUrl": "https://www.baidu.com/",
   "accessTokenTimeout": 7200,
   "refreshTokenTimeout": 604800,
   "appTypeCode": "1",
   "appOwner": 0,
   "loginTheme": "inspur"
}

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "9c67cb3b-664a-4c1d-ab11-1057869e8d86",
      "appName": "路况实时监测v10",
      "appCode": "traffic_recognitionv10",
      "appIcon": null,
      "appAuthType": "0",
      "authinfoSyncType": "0",
      "appTypeCode": "1",
      "appStatus": "1",
      "appAuthStatus": "1",
      "creator": "inspurtest06",
      "a5tId": "cee62708-c4fc-4f8d-917e-dcec22fa6dcb",
      "appDeleteFlag": "0",
      "createdTime": "2021-09-18 16:38:22",
      "updatedTime": "2021-09-18 16:38:22",
      "accessTokenTimeout": 7200,
      "refreshTokenTimeout": 604800,
      "redirectUri": "https://www.baidu.com/",
      "homepageUrl": "https://www.baidu.com/",
      "c4tId": "traffic_recognitionv10",
      "c4tS4t": "34b557db-6af3-473a-b338-8b94b404e0bd",
      "appOwner": "0",
      "idBind": null,
      "realm": "inspurtest06",
      "loginTheme": "inspur"
   },
   "status": 200,
   "requestId": ""
}

应用管理更新App信息

基本信息

Path： /idaas/v1/idaas/v1/apps/updateapp

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须
id	string	必须
appName	string	非必须
a5tId	string	非必须
appCode	string	非必须
description	string	非必须
authinfoSyncType	number	非必须
appAuthType	number	非必须
appStatus	number	非必须
appAuthStatus	number	非必须
redirectUri	string	非必须
homepageUrl	string	非必须
accessTokenTimeout	number	非必须
refreshTokenTimeout	number	非必须
appTypeCode	string	非必须
appOwner	number	非必须
loginTheme	string	非必须

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "9c67cb3b-664a-4c1d-ab11-1057869e8d86",
      "appName": "路况实时监测v1010",
      "appCode": "traffic_recognitionv1010",
      "appIcon": null,
      "appAuthType": "0",
      "authinfoSyncType": "0",
      "appTypeCode": "WEB",
      "appStatus": "1",
      "appAuthStatus": "1",
      "creator": "inspurtest06",
      "a5tId": "35237973-1071-43dd-9ac5-852f98758ef8",
      "appDeleteFlag": "0",
      "createdTime": "2021-09-18 16:38:22",
      "updatedTime": "2021-09-18 17:48:15",
      "accessTokenTimeout": 10800,
      "refreshTokenTimeout": 604800,
      "redirectUri": "https://www.baidu.com/",
      "homepageUrl": "https://www.baidu.com/",
      "c4tId": "traffic_recognitionv10",
      "c4tS4t": "34b557db-6af3-473a-b338-8b94b404e0bd",
      "appOwner": "0",
      "idBind": null,
      "realm": "inspurtest06",
      "loginTheme": "inspurcloud"
   },
   "status": 200,
   "requestId": ""
}

应用管理查询Application

基本信息

Path： /idaas/v1/idaas/v1/apps/{appId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
appId	0f09373a57f74b978c645e55f412bb12

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "AE74BC6608B042AD8EF716B5B0D2FF63",
      "appName": "aabbccddeeffgg",
      "appCode": "app8",
      "appIcon": "E:/图标/app8.jpg",
      "appAuthType": "0",
      "authinfoSyncType": "0",
      "equipType": "0",
      "appStatus": "1",
      "appAuthStatus": "0",
      "creator": "dev",
      "accountId": "abcde",
      "appDeleteFlag": "1",
      "createdTime": "2021-08-11 20:30:32",
      "updatedTime": "2021-08-11 20:30:32"
   },
   "status": 200,
   "requestId": ""
}

应用管理验证appCode是否重复

基本信息

Path： /idaas/v1/idaas/v1/apps/action/verify-appcode/{appcode}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appcode	app2

返回数据

{
   "code": "200",
   "message": "ok",
   "data": false,
   "status": 200,
   "requestId": ""
}

应用管理验证appName是否重复

基本信息

Path： /idaas/v1/idaas/v1/apps/action/verify-appname/{appname}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appname

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

获取组织机构应用授权/未授权列表

基本信息

Path： /idaas/v1/idaas/v1/apps/{orgId}/listapporgauthinfo/page/{pageNo}/{pageSize}?appName=应用名称

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
orgId	3B5A6590693C421DB9C3304A08808FA7	必需
pageNo	1	必需
pageSize	10	必需

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 10,
      "totalCount": 4,
      "pages": 1,
      "data": [
         {
            "appName": "应用名称8",
            "appId": "DCB99FFDC79F4930B93BEBA1B62F135B",
            "authFlag": 0
         },
         {
            "appName": "应用名称7",
            "appId": "F19FED54D57E4FE2B39E0B5892E38B09",
            "authFlag": 1,
            "orgId": "3B5A6590693C421DB9C3304A08808FA7"
         },
         {
            "appName": "应用名称555",
            "appId": "3D798BAE694044CAA08D954A85837313",
            "authFlag": 0
         },
         {
            "appName": "应用名称1",
            "appId": "58A0B2F7A51B44039F4B4F186F4747FB",
            "authFlag": 0
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

应用类别管理

AppType 列表展示

基本信息

Path： /idaas/v1/idaas/v1/idaas/v1/apptypes/listapptypes/page/{pageNo}/{pageSize}?typeName=111

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1	第一页
pageSize	10	每页10条

Query

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

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 10,
      "totalCount": 0,
      "pages": 0,
      "data": [
         {
            "id": "9A91BD3D12F04A7DB2805194B4A184E4",
            "appName": "web",
            "appCode": "web123",
            "appType": "1",
            "creator": "dev",
            "a5tId": "123456",
            "appDeleteFlag": null,
            "createdTime": "2021-08-12 11:15:18",
            "updatedTime": "2021-08-12 11:15:18",
            "description": null
         },
         {
            "id": "32FC75CF32254440A8047102B7EB9E9E",
            "appName": null,
            "appCode": null,
            "appType": null,
            "creator": "dev",
            "a5tId": null,
            "appDeleteFlag": null,
            "createdTime": "2021-08-12 11:12:52",
            "updatedTime": "2021-08-12 11:12:52",
            "description": null
         },
         {
            "id": "383F40A6EA9A404281C94C54EFA79CD6",
            "appName": "abcd11122",
            "appCode": "app5",
            "appType": "0",
            "creator": "dev",
            "a5tId": "abcccc",
            "appDeleteFlag": null,
            "createdTime": "2021-08-12 10:42:52",
            "updatedTime": "2021-08-12 10:42:52",
            "description": "应用描述"
         },
         {
            "id": "3660F4CBA4134D82AC1DC367CD710526",
            "appName": "移动",
            "appCode": "yd123",
            "appType": "1",
            "creator": "dev",
            "a5tId": "移动应用",
            "appDeleteFlag": null,
            "createdTime": "2021-08-11 21:30:53",
            "updatedTime": "2021-08-11 21:30:53",
            "description": null
         },
         {
            "id": "276314F3E0B04FBA809A5A7B0268ED26",
            "appName": null,
            "appCode": null,
            "appType": null,
            "creator": "dev",
            "a5tId": null,
            "appDeleteFlag": null,
            "createdTime": "2021-08-11 21:22:43",
            "updatedTime": "2021-08-11 21:22:43",
            "description": null
         },
         {
            "id": "B4D426DF1B004454AD0E56DE335FC9C0",
            "appName": null,
            "appCode": null,
            "appType": null,
            "creator": "dev",
            "a5tId": null,
            "appDeleteFlag": null,
            "createdTime": "2021-08-11 20:42:52",
            "updatedTime": "2021-08-11 20:42:52",
            "description": null
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

删除应用类型

基本信息

Path： /idaas/v1/idaas/v1/apptypes/{appTypeId}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
appTypeId	F8AC880ABF594EBDA59523FB86DDBF3A

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "EF42D290C85C45C59CE837C0BFE84366",
      "appName": "abcd11122",
      "appCode": "app5",
      "appType": "0",
      "creator": "dev",
      "accountId": "abcccc",
      "appDeleteFlag": "1",
      "createdTime": "2021-08-12 10:04:18",
      "updatedTime": "2021-08-12 10:04:18"
   },
   "status": 200,
   "requestId": ""
}

应用类型下拉列表

基本信息

Path： /idaas/v1/idaas/v1/apptypes/list

Method： GET

接口描述：

请求参数

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "088C5CE483084AA981337FE6723EE30D",
         "typeName": "类别777",
         "typeCode": "type777",
         "creator": "dev",
         "a5tId": "abcde2",
         "typeDeleteFlag": "0",
         "createdTime": "2021-08-17 14:41:09",
         "updatedTime": "2021-08-17 14:41:09",
         "description": "type777",
         "typeStatus": "1"
      },
      {
         "id": "5881D295366840AD9BD982F83E2A1805",
         "typeName": "类别888",
         "typeCode": "type888",
         "creator": "dev",
         "a5tId": "abcde2",
         "typeDeleteFlag": "0",
         "createdTime": "2021-08-17 14:47:13",
         "updatedTime": "2021-08-17 14:47:13",
         "description": "type888",
         "typeStatus": "1"
      }
   ],
   "status": 200,
   "requestId": ""
}

新增应用类型

基本信息

Path： /idaas/v1/idaas/v1/apptypes

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "typeName": "类别222",
   "a5tId": "abcde2",
   "typeCode": "type222",
   "description": "type222"
}

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "EF42D290C85C45C59CE837C0BFE84366",
      "appName": "abcd11122",
      "appCode": "app5",
      "appType": "0",
      "creator": "dev",
      "accountId": "abcccc",
      "appDeleteFlag": "0",
      "createdTime": "2021-08-12 10:04:18",
      "updatedTime": "2021-08-12 10:04:18"
   },
   "status": 200,
   "requestId": ""
}

更新应用类别信息

基本信息

Path： /idaas/v1/idaas/v1/apptypes/updateapptype

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须
id	string	必须
typeName	string	非必须
typeCode	string	非必须
a5tId	string	非必须
description	string	非必须

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "383F40A6EA9A404281C94C54EFA79CD6",
      "appName": "testUpdate",
      "appCode": "app_testUpdate",
      "appType": "1",
      "creator": "dev",
      "a5tId": "abcccc",
      "appDeleteFlag": "0",
      "createdTime": "2021-08-12 10:42:52",
      "updatedTime": "2021-08-12 17:39:51",
      "description": "description_testUpdate"
   },
   "status": 200,
   "requestId": ""
}

查询应用类型

基本信息

Path： /idaas/v1/idaas/v1/apptypes/{appTypeId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
appTypeId	F8AC880ABF594EBDA59523FB86DDBF3A

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "83F0EB394C0E4ED3A1C57E2E85F77734",
      "appName": "abcd111",
      "appCode": "app3",
      "appType": "0",
      "creator": "dev",
      "accountId": "abcccc",
      "appDeleteFlag": "1",
      "createdTime": "2021-08-11 20:35:16",
      "updatedTime": "2021-08-11 20:35:16"
   },
   "status": 200,
   "requestId": ""
}

根据typecode查询应用类别信息

基本信息

Path： /idaas/v1/idaas/v1/apptypes/getapptypeinfo/{typecode}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
typecode	web123

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "B9CCECE791C443939518EA161CAF9A8F",
         "typeName": "web",
         "typeCode": "web123",
         "creator": "dev",
         "a5tId": null,
         "typeDeleteFlag": null,
         "createdTime": "2021-08-17 09:37:31",
         "updatedTime": "2021-08-17 20:14:47",
         "description": "web应用类型",
         "typeStatus": "1"
      }
   ],
   "status": 200,
   "requestId": ""
}

验证apptypeCode是否重复

基本信息

Path： /idaas/v1/idaas/v1/apptypes/action/verify-appcode/{apptypeCode}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
apptypeCode	type222

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

验证typeName是否重复

基本信息

Path： /idaas/v1/idaas/v1/apptypes/action/verify-apptypename/{typename}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
typename	类别1111

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

账户类型管理

删除账户类型

基本信息

Path： /idaas/v1/idaas/v1/userType/{id}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id

返回数据

{
   "code": "200",
   "message": "ok",
   "status": 200,
   "requestId": ""
}

新增账户类型

基本信息

Path： /idaas/v1/idaas/v1/userType

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
id	string	非必须	主键主键，存在时更新，为空时新增
name	string	必须	类型名称
code	string	必须	类型编码
description	string	必须	应用类型描述
order	number	必须	排序

返回数据

名称	类型	是否必须
code	string	必须
message	string	必须
data	string	必须

账户类型不分页查询

基本信息

Path： /idaas/v1/idaas/v1/userType/list

Method： GET

接口描述：

请求参数

Query

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

返回数据

{
   "code": "200",
   "message": "ok",
   "data": [
      {
         "id": "E62BD50388ED4DE2A63D6A8D9AA3A560",
         "code": "test",
         "name": "test01",
         "description": "akwkhdh",
         "order": 1
      }
   ],
   "status": 200,
   "requestId": ""
}

账户类型分页查询

基本信息

Path： /idaas/v1/idaas/v1/userType/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1
pageSize	10

Query

参数名称	是否必须	示例	备注
name	否		查询字段，按名称模糊查询

返回数据

名称	类型	是否必须	其他信息
code	string	非必须
message	string	非必须
data	object	非必须
├─ code	number	非必须
├─ msg	null	非必须
├─ pageNo	number	非必须
├─ pageSize	number	非必须
├─ totalCount	number	非必须
├─ pages	number	非必须
├─ data	object []	非必须	item 类型: object
├─ id	string	非必须
├─ code	null	非必须
├─ name	string	非必须
├─ description	null	非必须
├─ order	number	非必须
status	number	非必须
requestId	string	非必须

账户类型名称重复校验

基本信息

Path： /idaas/v1/idaas/v1/userType/action/verify-name/{name}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
name

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

账户类型启用

基本信息

Path： /idaas/v1/idaas/v1/userType/{id}/action/start

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id

返回数据

{
   "code": "200",
   "message": "ok",
   "status": 200,
   "requestId": ""
}

账户类型查看详情

基本信息

Path： /idaas/v1/idaas/v1/userType/{id}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
id

返回数据

{
  "code": "200",
  "message": "ok",
  "data": {
    "id": "97D5C15533EE48CB8BBCEB6ABD9C6B48",
    "code": null,
    "name": "test02",
    "description": "akwkhdh",
    "order": 1,
  },
  "status": 200,
  "requestId": ""
}

账户类型禁用

基本信息

Path： /idaas/v1/idaas/v1/userType/{id}/action/stop

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
id

返回数据

{
   "code": "200",
   "message": "ok",
   "status": 200,
   "requestId": ""
}

账户类型编码重复校验

基本信息

Path： /idaas/v1/idaas/v1/userType/action/verify-code/{code}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
code

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

文件上传下载

文件上传接口

基本信息

Path： /idaas/v1/file/upload

Method： POST

接口描述：

请求参数

Body

file

返回数据

{
   "code": "200",
   "message": "ok",
   "data": "20210822992108131159373501004797",
   "status": 200,
   "requestId": ""
}

文件下载

基本信息

Path： /idaas/v1/file/download/{fileId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
fileId		文件上传后返回的文件ID

用户组

从用户组中移除成员

基本信息

Path： /idaas/v1/groups/{groupId}/users/remove

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
groupId		用户组id

Body

名称	类型	是否必须	默认值	备注	其他信息
userIdList	string []	必须		用户id列表	item 类型: string
├─		非必须		id项 id项

删除用户组

基本信息

Path： /idaas/v1/groups/{groupId}

Method： DELETE

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
groupId		用户组id

向用户组中添加成员

基本信息

Path： /idaas/v1/groups/{groupId}/users

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
groupId		用户组id

Body

名称	类型	是否必须	默认值	备注	其他信息
userIdList	string []	必须		用户id列表	item 类型: string
├─		非必须		用户id项

新增/编辑用户组

基本信息

Path： /idaas/v1/groups

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须	备注
id	string	必须	id。新建用户组时不传，编辑用户组时必传
name	string	必须	用户组名称。创建必填，修改选填
externalId	string	非必须	创建不必填，一旦创建成功不可修改
description	string	非必须	描述
organId	string	必须	组织机构id。创建必填，一旦创建成功无法修改

查询可加入用户组的用户分页列表

基本信息

Path： /idaas/v1/groups/{groupId}/users/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
groupId		用户组id
pageNo		页数
pageSize		每页数据大小

Query

参数名称	是否必须	示例	备注
accountName	否	张三	账户名
nickName	否	李四	昵称

返回数据

名称	类型	是否必须	备注	其他信息
data	object []	非必须		item 类型: object
├─ updatedTime	string	必须
├─ accountName	string	必须
├─ nickName	string	必须
├─ description	string	必须
├─ isMember	number	必须	是否已进该组
├─ createdType	string	必须
├─ organizationId	string	必须
├─ path	string	必须
├─ phone	string	必须
├─ expirationTime	string	必须
├─ userTypeName	string	必须
├─ createdTime	string	必须
├─ id	string	必须
├─ userType	string	必须
├─ email	string	必须
├─ p6d	string	必须
├─ status	string	必须	用户状态

查询用户加入的用户组分页列表

基本信息

Path： /idaas/v1/users/{userId}/groups/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
userId		用户id
pageNo	1	当前页号
pageSize	10

Query

参数名称	是否必须	示例	备注
groupName	否	应用使能组	用户组名称，非必填

查询用户组分页列表

基本信息

Path： /idaas/v1/groups/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1	当前页号
pageSize	10	每页中数据条数

Query

参数名称	是否必须	示例	备注
organId	否		查询某组织机构下的用户组
name	否		搜索条件：用户组名称

查询用户组成员分页列表

基本信息

Path： /idaas/v1/groups/{groupId}/members/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
groupId		用户组id
pageNo	1	当前页数
pageSize	10	每页数据条数

Query

参数名称	是否必须	示例	备注
accountName	否	lzy	账户名（搜索条件）
nickName	否	李四	用户昵称（搜索条件）

根据id查询用户组

基本信息

Path： /idaas/v1/groups/{groupId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
groupId		用户组Id

字典管理

新增字典

基本信息

Path： /idaas/v1/dict

Method： POST

接口描述：

请求参数

Headers

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

Body

{
   "dictCode": "dict3_code",
   "dictName": "字典3",
   "dictOrder": "1",
   "dictStatus": "1",
   "description": "字典3"
}

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "6D403BAA1C4A45618C4F3BE5DC83F56B",
      "dictCode": "dict3_code",
      "dictName": "字典3",
      "dictType": null,
      "referenceStandard": null,
      "dictOrder": "1",
      "dictStatus": "1",
      "createdTime": "2021-09-10 17:39:29",
      "updatedTime": "2021-09-10 17:39:29",
      "creator": "inspurtest03",
      "description": "字典3"
   },
   "status": 200,
   "requestId": ""
}

查询字典信息

基本信息

Path： /idaas/v1/dict/{dictId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
dictId	6D403BAA1C4A45618C4F3BE5DC83F56B

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "6D403BAA1C4A45618C4F3BE5DC83F56B",
      "dictCode": "dict3_code",
      "dictName": "字典3",
      "dictType": null,
      "referenceStandard": null,
      "dictOrder": "1",
      "dictStatus": "1",
      "createdTime": "2021-09-10 17:39:29",
      "updatedTime": "2021-09-10 17:39:29",
      "creator": "inspurtest03",
      "description": "字典3"
   },
   "status": 200,
   "requestId": ""
}

验证字典Code是否重复

基本信息

Path： /idaas/v1/dict/action/verify-dictcode/{code}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
code	dict3_code

返回数据

{
   "code": "200",
   "message": "ok",
   "data": false,
   "status": 200,
   "requestId": ""
}

验证字典Name是否重复

基本信息

Path： /idaas/v1/dict/action/verify-dictname/{name}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
name	字典3

返回数据

{
   "code": "200",
   "message": "ok",
   "data": false,
   "status": 200,
   "requestId": ""
}

获取字典分页列表

基本信息

Path： /idaas/v1/dict/listdicts/page/{pageNo}/{pageSize}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
pageNo	1
pageSize	10

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "code": 1,
      "msg": null,
      "pageNo": 1,
      "pageSize": 3,
      "totalCount": 3,
      "pages": 1,
      "data": [
         {
            "updatedTime": "2021-09-10 17:39:29",
            "dictStatus": "1",
            "dictCode": "dict3_code",
            "dictOrder": "1",
            "description": "字典3",
            "dictName": "字典3",
            "id": "6D403BAA1C4A45618C4F3BE5DC83F56B"
         },
         {
            "updatedTime": "2021-09-10 17:36:01",
            "dictStatus": "1",
            "dictCode": "dict111_code",
            "dictOrder": "1",
            "description": "字典111",
            "dictName": "字典111",
            "id": "D593CC38B3384521A617649671AAAC98"
         },
         {
            "updatedTime": "2021-09-10 16:26:33",
            "dictStatus": "1",
            "dictCode": "dict2_code",
            "dictOrder": "1",
            "description": "字典2",
            "dictName": "字典2",
            "id": "BD25641733744AE5B7DFA05E7E6EAE4D"
         }
      ]
   },
   "status": 200,
   "requestId": ""
}

更新字典

基本信息

Path： /idaas/v1/dict/updatedict

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须
id	string	必须
dictCode	string	非必须
dictName	string	非必须
dictOrder	string	非必须
dictStatus	string	非必须
description	string	非必须

返回数据

{
   "code": "200",
   "message": "成功",
   "data": {
      "id": "6D403BAA1C4A45618C4F3BE5DC83F56B",
      "dictCode": "dict33_code",
      "dictName": "字典33",
      "dictType": null,
      "referenceStandard": null,
      "dictOrder": "1",
      "dictStatus": "1",
      "createdTime": "2021-09-10 17:39:29",
      "updatedTime": "2021-09-10 18:01:37",
      "creator": "inspurtest03",
      "description": "字典33"
   },
   "status": 200,
   "requestId": ""
}

字典项管理

创建字典项

基本信息

Path： /idaas/v1/dictitems

Method： POST

接口描述：

请求参数

Headers

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

Body

名称	类型	是否必须
dictId	string	必须
dictItemTag	string	非必须
dictItemValue	string	非必须
dictItemOrder	string	非必须
dictStatus	string	非必须
description	string	非必须

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "FF2741815B2341799B0CFA355F8419E5",
      "dictId": "6D403BAA1C4A45618C4F3BE5DC83F56B",
      "dictItemTag": "字典33_Tag1",
      "dictItemValue": "dict33_value1",
      "dictItemOrder": null,
      "createdTime": "2021-09-13 09:53:25",
      "updatedTime": "2021-09-13 09:53:25",
      "creator": "inspurtest03",
      "description": "字典33_item1"
   },
   "status": 200,
   "requestId": ""
}

按Id查询字典项详情

基本信息

Path： /idaas/v1/dictitems/{dictItemId}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
dictItemId	FF2741815B2341799B0CFA355F8419E5

返回数据

{
   "code": "200",
   "message": "ok",
   "data": {
      "id": "FF2741815B2341799B0CFA355F8419E5",
      "dictId": "6D403BAA1C4A45618C4F3BE5DC83F56B",
      "dictItemTag": "字典33_Tag1",
      "dictItemValue": "dict33_value1",
      "dictItemOrder": "1",
      "createdTime": "2021-09-13 09:53:25",
      "updatedTime": "2021-09-13 09:53:25",
      "creator": "inspurtest03",
      "description": "字典33_item1"
   },
   "status": 200,
   "requestId": ""
}

验证字典项Tag是否重复

基本信息

Path： /idaas/v1/dictitems/action/verify-dictitemtag/{tag}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
tag	字典33_Tag1

返回数据

{
   "code": "200",
   "message": "ok",
   "data": false,
   "status": 200,
   "requestId": ""
}

验证字典项Value是否重复

基本信息

Path： /idaas/v1/dictitems/action/verify-dictitemvalue/{value}

Method： POST

接口描述：

请求参数

Headers

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

路径参数

参数名称	示例	备注
value	dict33_value1

返回数据

{
   "code": "200",
   "message": "ok",
   "data": true,
   "status": 200,
   "requestId": ""
}

用户认证

生成code

Path： /render/{主账号}/{应用ID}/auth

Method： GET

接口描述： 前缀以租户侧地址开头，主账号即登录IDaaS的账号名称，调用成功后会携带code参数跳转到当前应用对应配置的回调地址，需要通过回调地址获取code值。

通过上一步生成的code获取token

Path： /token

Method： POST

接口描述： 前缀以租户侧地址开头

请求参数

Headers

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

路径参数

参数名称	参数位置	是否必须	备注
grant_type	query	是	authorization_code：授权码模式
client_id	query	是	应用唯一标识ID
client_secret	query	是	应用密钥
code	query	是	上一步骤中获取的code

验证token有效性

接口描述：

验证token有效性接口

Path： /token/verify

Method： POST

请求参数

Headers

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

路径参数

参数名称	参数位置	是否必须	备注
accessToken	query	是	上一步骤中获取到的accessToken字段
client_id	query	是	应用唯一标识ID