1. 用户

1.1. 用户说明

1.1.1. 用户的定义

HENGSHI 系统内的用户及 SSO 认证后自动创建用户,主要信息由登录名、邮箱、姓名、手机号码、用户属性等组成。 如果在系统中通过api创建了用户,再使用 SSO 认证是可以自动关联用户的。如: 通过api创建了用户loginName=demoTest,当通过 SSO 认证时的loginName也是demoTest,那么不会再自动创建用户, 而是将以demoTest的身份进行登录。关联的优先级是loginName,email,mobile。

用户结构说明

字段 类型 是否必须 描述
id LONG id
loginName STRING loginName,email,mobile不能同时为空 登录名,企业内不能重复。
email STRING loginName,email,mobile不能同时为空 邮箱,企业内不能重复。
password STRING 不使用密码登录时可以不设置 公钥加密密码,用base64格式进行编码。
uuid STRING 不使用密码登录时可以不设置 解密使用。
mobile STRING loginName,email,mobile不能同时为空 手机,企业内不能重复。
name STRING 显示名称(昵称)
userType STRING 默认为internal,可选值:internal,ldap,cas,oauth2,saml2,dingtalk,wechat-work,ctr,yunzhijia,jwt-param
description STRING 用户备注
avatar STRING 用户头像
roles JSON 数组 角色
roles[].id STRING 角色id
organizations JSON 数组 用户组
organizations[].id STRING 用户组id
platformConfig JSON 用户通过sso方式登陆同步的全局属性
config JSON 用户属性,其内容为自定义的用户属性,如:{"school":"a","grade":3}
resetPassword BOOLEAN 用户登录以后是否需要重置密码。

config字段说明:

  1. 用户可以在页面创建用户属性并赋值。
  2. 用户可以通过api调用传递用户属性,需要以用户结构说明中的config,如:

      {
         "loginName":"demoUser001",
         "config":{
             "text":"a",
             "number":1,
             "array":[
                 "test1"
             ]
         }
     }
    
  3. oauth,jwt认证方式登录时会将除登录名,用户名,邮箱,手机,角色以外的json字段自动封装成用户属性,如下json,会将school、grade封装成用户属性,保存到用户的config字段。

    {
        "loginName":"loginName",//登录名映射
        "email":"email",//邮箱映射
        "mobile":"mobile",//手机映射
        "name":"name",//用户名映射
        "school":"a",//用户属性
        "grade":3 //用户属性
    }
    
  4. 钉钉,企业微信,云之家认证方式登录时会将除登录名,用户名,邮箱,手机,角色以外的json自动封装成用户属性。具体的用户信息由 钉钉企业微信云之家 接口返回,请参考官方文档。

角色结构说明

字段 类型 是否必须 描述
id LONG id
name STRING 角色名称
description STRING 角色描述

角色是系统内置数据,不可更新, 系统内角色有:

name 角色
system admin 系统管理
data admin 数据管理
data analyst 数据分析
data viewer 数据查看
api admin API 管理员

用户组结构说明

字段 类型 是否必须 描述
id LONG id
name STRING 名称
email STRING 邮箱
description STRING 用户组备注
users JSON 数组 用户
users[].id LONG 角色id

1.2. 接口说明

1.2.1. 获取角色列表

获取角色列表。

请求URL

GET /api/v1/users/roles

请求参数

URL 参数

request body 参数

说明

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 角色结构说明

GET /api/v1/users/roles

返回

{
   "version":"",
   "code":0,
   "msg":"success",
   "data":[
      {
         "id":1,
         "name":"system admin",
         "description":"system admin"
      },
      {
         "id":2,
         "name":"data admin",
         "description":"data admin"
      },
      {
         "id":3,
         "name":"data analyst",
         "description":"data analyst"
      },
      {
         "id":4,
         "name":"data viewer",
         "description":"data viewer"
      },
      {
         "id":5,
         "name":"api admin",
         "description":"api admin"
      }
   ]
}

1.2.2. 创建用户

创建用户。

请求URL

POST /api/v1/users

请求参数

URL 参数

request body 参数

用户结构说明
密码加密

说明

用户属性需要放在config字段中传递

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data.id LONG 用户的 id

用户默认头像

avatar

接口示例1: 创建用户(完整信息)

包含基本完整的用户信息,创建成功以后,用户可以根据登录名和密码登录。使用场景多为预先创建,配置用户,使用用户名/密码方式登录使用系统。
POST /api/v1/users

{
    "loginName":"demoUser001",
    "name":"demoUser001",
    "email":"demoUser001@hengshi.com",
    "password":"duk5ZIVdikKtU9txy0aMZlLPJ8hntpINLx2hBWiJw8sYfSxSQ/pkSBRv85s/ROQb45J4R8MsCrN7VQkhONMoGQ==",
    "description":"desc",
    "uuid":"488b4801-1f50-4694-b0e1-7bd8fea4869f",
    "roles":[
        {
            "id":3
        },
        {
            "id":4
        },
        {
            "id":2
        }
    ],
    "config":{
      "text":"a",
      "number":1,
      "array":["test1"]
    },
    "organizations":[
        {
            "id":25
        }
    ],
    "avatar":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAADAFBMVEXw8PAm2IkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAc0xRVAAABAHRSTlP//wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKmfXxgAAJ39JREFUeNoBdCeL2AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAABAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAW08GwWcCji0AAAAASUVORK5CYII="
}

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "id":800
    }
}

接口示例2: 创建用户(必要信息)

只包含必要的用户信息,使用场景多为预先创建,根据需要配置用户角色(roles),用户属性(config)等,之后使用其他的认证方式(如单点登录,jwt等)登录使用系统。

POST /api/v1/users

{
   "loginName": "13333333333",
   "roles": [
      {
         "id": 1
      }
   ]
}

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "id":800
    }
}

1.2.3. 管理员修改用户

管理员修改用户。

请求URL

PUT /api/v1/users/{userId}

请求参数

URL 参数
字段 类型 是否必须 说明
userId LONG 修改用户的 id
request body 参数

用户结构说明 密码加密

说明

用户属性需要放在config字段中传递

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值

修改用户属性说明

若在更新用户时通过config修改用户属性,则需要传被修改用户的全量属性,该修改为直接覆盖,没有传的属性都会被置空

重制密码说明

若调用该接口修改(随机重置)用户密码,则被修改用户下次登陆时需要自行再重置一次密码

接口示例1: 修改用户

PUT /api/v1/users/{userId}

{
    "enable":true,
    "description":"desc",
    "uuid":"b8ad2610-c981-4fc2-9557-2ba48966639a",
    "roles":[
        {
            "id":2
        },
        {
            "id":3
        },
        {
            "id":4
        }
    ],
    "config":{
        "text":"a",
        "number":1,
        "array":["test1"]
    },
    "organizations":[
        {
            "id":25
        }
    ]
}

返回

{
    "version":"",
    "code":0,
    "msg":"success"
}

接口示例2: 修改用户(重置密码)

PUT /api/v1/users/{userId}

{
  "enable": true,
  "description": "",
  "password": "UEDK5yrm3xswER2JgWvMELLR3aETo76qKBOg5PW/4pDsP9270a+mYE5kkWXFfHYUqiZtPsC4Apumis3BG3oUlw==",
  "uuid": "68a5d0c6-5a33-45d6-833a-9b70c961a77a",
  "config": {},
  "roles": [
    {
      "id": 1
    },
    {
      "id": 2
    },
    {
      "id": 3
    },
    {
      "id": 4
    }
  ],
  "organizations": []
}

返回

{
    "version":"",
    "code":0,
    "msg":"success"
}

接口示例3: 修改用户(用户属性)

PUT /api/v1/users/{userId}

{
  "enable": true,
  "description": "",
  "uuid": "ab999a4c-3c79-4de2-9e96-d26a814c3d70",
  "config": {
    "a1": "测试",
    "a2": [
      "测试1","测试2"
    ],
    "t": "2020-07-23 16:11:00",
    "n": 1
  },
  "roles": [
    {
      "id": 1
    },
    {
      "id": 2
    },
    {
      "id": 3
    },
    {
      "id": 4
    }
  ],
  "organizations": [
    {
      "id": 2
    }
  ]
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success"
}

1.2.4. 用户自行修改帐号信息

用户自行修改帐号信息

请求URL

PUT /api/v1/users/account/{userId}

请求参数

URL 参数
字段 类型 是否必须 说明
userId LONG 修改用户的 id
request body 参数

用户结构说明 密码加密

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值

用户可修改的信息

通过该接口用户可修改用户的名称,头像,密码,使用语言

修改密码说明

若调用该接口修改用户密码,与管理员修改接口不同的时,该密码就直接作为用户登陆密码使用,无需再次被强制要求修改

不可同时更改多项信息

名称,头像,密码,使用语言一次调用只能修改其中一项,若四个参数都传,则按照密码>头像>名称>使用语言的顺序修改其中一项

接口示例1: 修改用户名称

PUT /api/v1/users/account/{userId}

{
  "name": "test1"
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success"
}

接口示例2: 修改密码

PUT /api/v1/users/account/{userId}

{
  "uuid": "7a292f10-9db4-4d7a-b8cb-f29fdfb86e58",
  "password": "QziD1WxdWSJjAdsx0YrRnOxItgPVoZNNAQVsz0X4/rzNehqtPxtcaWU7UQD2N4dIvDkfhxv/0EUjLL3BssoRtw==",
  "newPassword": "P5vmmFYGYRsasXx0/v3LauKN041OipE19xAPP+AKGDrNwkITzDlw5q0GFoy5jwH7tld8a3GJbvAZg9fqz1Pb+w=="
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success"
}

接口示例3: 修改头像

PUT /api/v1/users/account/{userId}

{
  "avatar": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQE"
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success"
}

接口示例4: 修改使用语言

PUT /api/v1/users/account/{userId}

{
  "options": {
    "language": "en-US"
  }
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success"
}

1.2.5. 删除用户

说明

  • 若用户拥有任意未删除或转移给其他用户的资源(应用、链接、数据集成、数据科学),则不可删除用户

请求URL

DELETE /api/users/{userId}

需要认证:是

请求参数

URL 参数
字段 类型 是否必须 说明
userId LONG 修改用户的 id

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例1: 删除用户

DELETE /api/users/{userId}

返回:

{
  "version": "",
  "code": 0,
  "msg": "success"
}

1.2.6. 通过 loginName 或者 email 查询用户(不推荐使用)

请参考 通过loginName查询用户 通过email查询用户 通过mobile查询用户

请求URL

GET /api/v1/users/by-unique-key/{loginName or email}

需要认证:是

请求参数

URL 参数
字段 类型 是否必须 说明
loginName or email STRING 用户的 loginName 或者 email

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例: 通过 loginName 或者 email 查询用户(不推荐使用)

GET /api/v1/users/by-unique-key/{loginName or email}

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2,
    "name": "helloa",
    "email": "helloa@163.com",
    "description": "",
    "avatar": "",
    "enable": true,
    "createdAt": "2019-11-15 15:18:36",
    "lastLoginAt": "2020-09-16 11:49:38",
    "userType": "internal",
    "isDelete": false,
    "loginName": "hello"
  }
}

1.2.7. 通过loginName查询用户

请求URL

POST /api/v1/users/get-by-loginname

需要认证:是

请求参数

URL 参数

request body 参数
字段 类型 是否必须 说明
loginName STRING 用户的 loginName

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例:

POST /api/v1/users/get-by-loginname

{
  "loginName": "helloa"
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2,
    "name": "helloa",
    "email": "helloa@163.com",
    "description": "",
    "avatar": "",
    "enable": true,
    "createdAt": "2019-11-15 15:18:36",
    "lastLoginAt": "2020-09-16 11:49:38",
    "userType": "internal",
    "isDelete": false,
    "loginName": "hello"
  }
}

1.2.8. 通过email查询用户

请求URL

POST /api/v1/users/get-by-email

需要认证:是

请求参数

URL 参数

request body 参数
字段 类型 是否必须 说明
email STRING 用户的 email

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例:

POST /api/v1/users/get-by-email

{
  "email": "helloa@163.com"
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2,
    "name": "helloa",
    "email": "helloa@163.com",
    "description": "",
    "avatar": "",
    "enable": true,
    "createdAt": "2019-11-15 15:18:36",
    "lastLoginAt": "2020-09-16 11:49:38",
    "userType": "internal",
    "isDelete": false,
    "loginName": "hello"
  }
}

1.2.9. 通过mobile查询用户

请求URL

POST /api/v1/users/get-by-mobile

需要认证:是

请求参数

URL 参数

request body 参数
字段 类型 是否必须 说明
mobile STRING 用户的 email

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例:

POST /api/v1/users/get-by-mobile

{
  "mobile": "13012344321"
}

返回

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2,
    "name": "helloa",
    "email": "helloa@163.com",
    "description": "",
    "avatar": "",
    "mobile": "13012344321",
    "enable": true,
    "createdAt": "2019-11-15 15:18:36",
    "lastLoginAt": "2020-09-16 11:49:38",
    "userType": "internal",
    "isDelete": false,
    "loginName": "hello"
  }
}

1.2.10. 获取用户列表

请求URL

GET /api/v1/users

需要认证:是

请求参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例1: 获取用户列表

GET /api/v1/users

返回:

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 2,
      "name": "test2",
      "email": "test2@hengshi.com",
      "description": "",
      "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAADAFBMVEXw8PAmstgA51gGMdj3GfUAAAAASUVORK5CYII=",
      "enable": true,
      "userType": "internal",
      "loginName": "test2",
      "config": {
        "sys.email": {
          "source": "SYSTEM_DEFINED",
          "value": "test2@hengshi.com",
          "type": "string"
        },
        "sys.login_name": {
          "source": "SYSTEM_DEFINED",
          "value": "test2",
          "type": "string"
        },
        "sys.mobile": {
          "source": "SYSTEM_DEFINED",
          "type": "string"
        },
        "sys.id": {
          "source": "SYSTEM_DEFINED",
          "value": 2,
          "type": "number"
        },
        "sys.loginName": {
          "source": "SYSTEM_DEFINED",
          "value": "test2",
          "type": "string"
        },
        "m_names": {
          "source": "USER_DEFINED",
          "value": [
            "盗梦空间",
            "搏击俱乐部"
          ],
          "type": "any"
        },
        "sys.name": {
          "source": "SYSTEM_DEFINED",
          "value": "test2",
          "type": "string"
        },
        "n_name": {
          "source": "USER_DEFINED",
          "value": "饮食男女",
          "type": "any",
          "defaultValue": "搏击俱乐部"
        }
      },
      "options": {},
      "roles": [
        {
          "id": 1,
          "name": "system admin",
          "description": "system admin"
        },
        {
          "id": 2,
          "name": "data admin",
          "description": "data admin"
        },
        {
          "id": 3,
          "name": "data analyst",
          "description": "data analyst"
        },
        {
          "id": 4,
          "name": "data viewer",
          "description": "data viewer"
        }
      ],
      "organizations": []
    },
    {
      "id": 9,
      "name": "test4",
      "email": "test4@hengshi.com",
      "description": "",
      "avatar": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAADAFBMVEXw8PAm2JAAm7YIceE7dPMAAAAASUVORK5CYII=",
      "enable": true,
      "userType": "internal",
      "loginName": "test4",
      "config": {
        "sys.email": {
          "source": "SYSTEM_DEFINED",
          "value": "test4@hengshi.com",
          "type": "string"
        },
        "sys.login_name": {
          "source": "SYSTEM_DEFINED",
          "value": "test4",
          "type": "string"
        },
        "sys.mobile": {
          "source": "SYSTEM_DEFINED",
          "type": "string"
        },
        "sys.id": {
          "source": "SYSTEM_DEFINED",
          "value": 9,
          "type": "number"
        },
        "sys.loginName": {
          "source": "SYSTEM_DEFINED",
          "value": "test4",
          "type": "string"
        },
        "sys.name": {
          "source": "SYSTEM_DEFINED",
          "value": "test4",
          "type": "string"
        }
      },
      "options": {},
      "roles": [
        {
          "id": 1,
          "name": "system admin",
          "description": "system admin"
        },
        {
          "id": 2,
          "name": "data admin",
          "description": "data admin"
        },
        {
          "id": 3,
          "name": "data analyst",
          "description": "data analyst"
        },
        {
          "id": 4,
          "name": "data viewer",
          "description": "data viewer"
        }
      ],
      "organizations": []
    }
  ]
}

1.2.11. 获得可被授权的用户列表

请求URL

GET /api/v1/users/grantors

需要认证:是

请求参数

URL 参数
字段 类型 是否必须 说明
act STRING 授权类型,可选值:collaborate(协作),publish(发布)
resource STRING 资源类型,可选值:app(应用),connection(链接)

说明

  1. 资源类型为connection时,授权类型不可为publish
  2. 当条件为app&collaborate时,返回的时系统中拥有数据分析角色的用户
  3. 当条件为app&publish时,返回的时系统中拥有数据查看角色的用户
  4. 当条件为connection&collaborate时,返回的时系统中拥有数据分析数据管理角色的用户

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 用户结构说明

接口示例1: 获得可被授权的用户列表

GET /api/v1/users/grantors?act=collaborate&resource=app

返回:

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 41,
      "name": "test",
      "email": "test@hengshi.com",
      "description": "",
      "enable": true,
      "loginName": "test",
      "config": {},
            "options": {}
        },
        {
            "id": 2,
            "name": "test2",
            "email": "test2@hengshi.com",
            "description": "",
            "enable": true,
            "loginName": "test2",
            "config": {
                "m_names": "[\"盗梦空间\",\"搏击俱乐部\"]",
                "n_name": "饮食男女"
            },
            "options": {}
        },
        {
            "id": 9,
            "name": "test4",
            "email": "test4@hengshi.com",
            "description": "",
            "enable": true,
            "loginName": "test4",
            "config": {},
            "options": {}
        }
    ]
}

1.2.12. 新增用户组

新增用户组。

请求URL

POST /api/v1/organizations

请求参数

URL 参数

request body 参数

用户组结构说明

返回对象的格式说明

用户组结构说明

接口示例1: 新增用户组

POST /api/v1/organizations

{
    "name":"zjj_group",
    "email":"zjj_group@hengshi.com",
    "description":"desc",
    "users":[
        {
            "id":800
        }
    ]
}

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "id":36,
        "name":"zjj_group",
        "email":"zjj_group@hengshi.com",
        "description":"desc",
        "createdBy":1,
        "createdAt":"2019-12-18 20:44:47",
        "updatedBy":1,
        "updatedAt":"2019-12-18 20:44:47",
        "users":[
            {
                "id":800,
                "userAttributes":{
                    "sys.id":800
                }
            }
        ]
    }
}

1.2.13. 获取用户组列表

请求URL

GET /api/v1/organizations

需要认证:是

请求参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 参数的共同结构见用户组结构说明

接口示例1: 获取用户组列表

GET /api/v1/organizations

返回:

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": [
    {
      "id": 1,
      "name": "ALL_USERS",
      "description": "System organization for all users",
      "category": "ALL_USERS",
      "userCount": 0,
      "users": []
    },
    {
      "id": 3,
      "name": "o4",
      "description": "",
      "category": "NORMAL",
      "userCount": 0,
      "users": []
    },
    {
      "id": 4,
      "name": "o42",
      "description": "",
      "category": "NORMAL",
      "userCount": 0,
      "users": []
    },
    {
      "id": 2,
      "name": "o1",
      "description": "",
      "category": "NORMAL",
      "userCount": 0,
      "users": []
    }
  ]
}

1.2.14. 根据ID获取用户组

请求URL

GET /api/v1/organizations/{organizationId}

需要认证:是

请求参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值
data OBJECT 参数的共同结构见用户组结构说明

接口示例1: 根据ID获取用户组

GET /api/v1/organizations/2

返回:

{
  "version": "",
  "code": 0,
  "msg": "success",
  "data": {
    "id": 2,
    "name": "o1",
    "description": "",
    "category": "NORMAL",
    "userCount": 2,
    "users": [
      {
        "id": 2,
                "name": "test2",
                "email": "test2@hengshi.com",
                "description": ""
            },
            {
                "id": 9,
                "name": "test4",
                "email": "test4@hengshi.com",
                "description": ""
            }
        ]
    }
}

1.2.15. 修改用户组

修改用户组。

请求URL

PUT /api/v1/organizations/{organizationId}

请求参数

URL 参数
字段 类型 是否必须 说明
organizationId LONG 修改用户组的 id
request body 参数

用户组结构说明

返回对象的格式说明

用户组结构说明

接口示例1: 修改用户组

PUT /api/v1/organizations/${organizationId}

{
    "name":"zjj_group",
    "email":"zjj_group@hengshi.com",
    "description":"desc",
    "users":[
        {
            "id":800
        }
    ]
}

返回

{
    "version":"",
    "code":0,
    "msg":"success",
    "data":{
        "id":36,
        "name":"zjj_group",
        "email":"zjj_group@hengshi.com",
        "description":"desc",
        "updatedBy":1,
        "updatedAt":"2019-12-18 20:46:51",
        "users":[
            {
                "id":800,
                "userAttributes":{
                    "$user.config.id":800,
                    "$user.id":800
                }
            }
        ]
    }
}

1.2.16. 删除用户组

删除用户组。

请求URL

DELETE /api/v1/organizations/{organizationId}

请求参数

URL 参数
字段 类型 是否必须 说明
organizationId LONG 修改用户组的 id
request body 参数

返回对象的格式说明

字段 类型 说明
version STRING 当前系统版本哈希值

接口示例1: 删除用户组

DELETE /api/v1/organizations/${organizationId} 返回

{
    "version":"",
    "code":0,
    "msg":"success"
}

results matching ""

    No results matching ""

    分享链接 用户属性