HTTP 请求
POST https://api.mokahr.com/api-platform/v1/users/list
请求query参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
next | 否 | string | 分页参数,如果有更多的数据可供拉取,响应的json中会有一个next字段,下次请求只需要把这个next参数加到query中就可以了。如果响应中没有next字段,表示没有更多的数据了 |
请求body参数
字段 | 必填 | 类型 | 描述 |
---|---|---|---|
roleId | 否 | integer | 角色id |
否 | string | 邮箱 | |
phone | 否 | string | 电话 |
number | 否 | string | 工号 |
deactivated | 否 | integer | 是否被禁用 |
departmentIdType | 否 | string | 此次调用中使用的部门ID类型。可选值: |
departmentId | 否 | string | 用户所属/负责部门id |
locale | 否 | string | 用户语言 |
limit | 否 | string | 分页用的每页条数,默认100,最大500 |
order | 否 | string | 拉取数据的排序方式, 排序key为用户创建时间.可选值为: |
返回
返回body的JSON数据如下:
字段 | 类型 | 描述 |
---|---|---|
code | number |
|
message | string | 提示信息 |
next | string | 分页参数,如果有更多的数据可供拉取,响应的json中会有一个next字段,下次请求只需要把这个next参数加到query中就可以了。如果响应中没有next字段,表示没有更多的数据了 |
data[].userId | string | 用户id |
data[].email | string | 邮箱 |
data[].name | string | 姓名 |
data[].phone | string | 电话 |
data[].number | stirng | 工号 |
data[].role | interger | 角色 |
data[].roleId | interger | 自定义角色id |
data[].superiorEmail | stirng | 上级邮箱 |
data[].deactivated | stirng | 是否被禁用 |
data[].isPending | boolean | 功能性字段,用作单点登录,没有传空字符串 |
data[].thirdPartyId | stirng | 功能性字段,用作单点登录,没有返回空字符串 |
data[].locale | string | 用户语言 |
data[].department | array | 用户所属/负责部门 |
data[].department[].departmentCode | string | 三方部门id |
data[].department[].departmentId | string | moka部门id |
data[].department[].name | string | 部门名称 |
请求样例 (JSON)
curl --location --request POST 'https://api.mokahr.com/api-platform/v1/users/list' \ --header 'Authorization: Basic Mm11UnVBQk******zY6' \ --header 'Content-Type: application/json' \ --data-raw '{ "deactivated": 0, "limit": "20", "order": "asc" }'
返回示例
{ "code": 200, "message": "success", "data": [ { "userId": 200000188, "email": "test2@sdicfund.com", "name": "马田", "phone": "10065761890", "role": 50, "roleId": 200000145, "deactivated": 0, "thirdPartyId": "", "locale": "zh-CN", "department": [] }, { "userId": 200000307, "email": "1581904186@qq.com", "name": "耿凯3", "phone": "18732837638", "role": 30, "roleId": 200000143, "superiorEmail": "test@sdicfund.com", "deactivated": 0, "thirdPartyId": "", "locale": "zh-CN", "department": [] } ], "next": "200000317" }