用户管理接口
创建一个用户
接口概述
- 功能:创建用户的功能,提交用户信息完成用户账户的注册与初始化,并返回新建用户的基本信息。
- 请求方式:POST
- 请求地址: /dw-open-api/user/create-user.do
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appId | string | 是 | 平台分配的appId |
| deptCodes | string | 否 | 部门代码,多个用','分开 |
| deptIds | string | 否 | 部门ID,多个用','分开 |
| string | 是 | 用户邮箱,新用户必须传入 | |
| loginName | string | 是 | 用户登录名称,新用户必须传入 |
| mobile | string | 是 | 用户手机号,新用户必须传入 |
| nonce | string | 是 | 随机字符串 |
| pwd | string | 是 | 用户密码,新用户必须传入 |
| roleCodes | string | 否 | 角色代码,多个用','分开 |
| roleIds | string | 否 | 角色ID,多个用','分开 |
| signature | string | 是 | 签名 |
| thirdUserId | string | 否 | 第三方平台用户ID,如果创建的时候绑定了第三方平台ID,则可以用于登录,登录时与userId只需要传一个。 |
| timestamp | string | 是 | 当前时间戳 |
| userName | string | 是 | 用户名称,新用户必须传入 |
请求示例
http://192.168.5.43:9999/dw-open-api/user/create-user.do?appId=asdf&deptCodes=dsfa&deptIds=fdas&email=service%40dw1.net&loginName=nb&mobile=111231464&nonce=dfas&pwd=123456&roleCodes=adfs&roleIds=dsaf&signature=as&thirdUserId=sdadsf×tamp=415645454&userName=nb返回值
json
{
"resultCode": 200,
"resultMsg": "执行成功",
"data": {
"id": "4b56fffa-8d97-48f1-b65e-3793758aab58",
"loginName": "nb",
"name": "nb",
"email": "service@dw1.net",
"cellphone": "111231464",
"thirdUserId": "sdadsf"
}
}编辑一个用户
接口概述
- 功能:编辑用户的功能,更新指定用户的账户信息,并返回更新后的用户基本信息。
- 请求方式:POST
- 请求地址: /dw-open-api/user/edit-user.do
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appId | string | 是 | 平台分配的appId |
| string | 否 | 用户邮箱,新用户必须传入 | |
| loginName | string | 否 | 用户登录名称,【userId,loginName,thirdUserId 至少传一个】 |
| mobile | string | 否 | 用户手机号,新用户必须传入 |
| nonce | string | 是 | 随机字符串 |
| pwd | string | 否 | 用户密码,新用户必须传入 |
| signature | string | 是 | 签名 |
| thirdUserId | string | 否 | 第三方平台ID【userId,loginName,thirdUserId 至少传一个】 |
| timestamp | string | 是 | 当前时间戳 |
| userId | string | 否 | 用户ID【userId,loginName,thirdUserId 至少传一个】 |
| userName | string | 否 | 用户名称,新用户必须传入 |
请求示例
http://192.168.5.43:9999/dw-open-api/user/edit-user.do?appId=gfh&email=service%40dw1.net&loginName=nb&mobile=13256456&nonce=sdfadsf&signature=adfasdf&thirdUserId=dsaf×tamp=a14654756&userId=sdaf&userName=nb返回值
json
{
"resultCode": 200,
"resultMsg": "执行成功",
"data": {
"id": "4b56fffa-8d97-48f1-b65e-3793758aab58",
"loginName": "nb",
"name": "nb",
"email": "service@dw1.net",
"cellphone": "13256456",
"thirdUserId": "dsaf"
}
}企业用户列表
接口概述
- 功能:企业用户列表查询的功能,支持分页和条件筛选,并返回符合条件的用户信息及分页数据。
- 请求方式:GET
- 请求地址: /dw-open-api/user/list-user.do
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appId | string | 是 | 平台分配的appId |
| string | 否 | 邮箱 | |
| loginName | string | 否 | 登录名称 |
| mobile | string | 否 | 手机号 |
| nonce | string | 是 | 随机字符串 |
| pageNo | integer($int32) | 否 | 页码,默认值1 |
| pageSize | integer($int32) | 否 | 页数据大小,默认值10 |
| signature | string | 是 | 签名 |
| status | integer($int32) | 否 | 账号状态 |
| timestamp | string | 是 | 当前时间戳 |
| userName | string | 否 | 用户名称 |
请求示例
http://192.168.5.43:9999/dw-open-api/user/list-user.do?appId=ghjfg&email=service%40dw1.net&loginName=nb&mobile=123455&nonce=fdsgasfd&signature=fdgfd&status=14556×tamp=453151541&userName=nb返回值
json
{
"resultCode": 200,
"resultMsg": "执行成功",
"data": {
"pageNo": 1,
"pageSize": 10,
"totalPage": 0,
"result": [],
"totalItems": 0
}
}查询用户
接口概述
- 功能:查询单个用户信息的功能,获取用户的详细账户及联系方式等信息。
- 请求方式:GET
- 请求地址: /dw-open-api/user/user-info.do
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| appId | string | 是 | 平台分配的appId |
| loginName | string | 否 | 登录账号【userId,loginName,thirdUserId 至少传一个】 |
| nonce | string | 是 | 随机字符串 |
| signature | string | 是 | 签名 |
| thirdUserId | string | 否 | 第三方平台ID【userId,loginName,thirdUserId 至少传一个】 |
| timestamp | string | 是 | 当前时间戳 |
| userId | string | 否 | 用户ID【userId,loginName,thirdUserId 至少传一个】 |
请求示例
http://192.168.5.43:9999/dw-open-api/user/user-info.do?appId=dsafds&loginName=nb&nonce=asdf&signature=asdf×tamp=45333333返回值
json
{
"resultCode": 200,
"resultMsg": "执行成功",
"data": {
"id": "4b56fffa-8d97-48f1-b65e-3793758aab58",
"loginName": "nb",
"name": "nb",
"email": "service@dw1.net",
"createTime": 1755672284000,
"editDate": 1755672284014,
"cellphone": "13256456",
"thirdUserId": "dsaf"
}
}
