用户
获取用户列表
注意:公有云或平台版不支持
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息(AppKey 和 SecretKey),组织可通过此密钥信息安全调用 HAP 平台开放的各类接口,包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Query 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 签名 |
timestamp | integer | 是 | 时间戳 |
projectId | string | 是 | HAP组织Id |
pageIndex | integer | 是 | 页码 |
pageSize | integer | 是 | 每页大小,最大 1000 |
userStatus | integer | 是 | 用户状态,1:正常 2:被拒绝加入 3:待审核 4:离职 |
响应参数
200| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 状态码,1表示操作完成;非1表示操作异常,非1时data字段不存在 |
message | string | 状态描述 |
data | object | — |
data.count | integer | 总数 |
data.users | object[] | 用户列表 |
data.users.accountId | string | HAP账号Id |
data.users.fullname | string | 姓名 |
data.users.avatar | string | 头像 |
data.users.email | string | 邮箱 |
data.users.mobilePhone | string | 手机号 |
data.users.contactPhone | string | 联系电话 |
data.users.jobNumber | string | 工号 |
data.users.lang | string | 用户系统语言 |
data.users.appLang | string | 用户应用语言 |
data.users.createTime | string | 创建时间 |
data.users.departmentInfos | object[] | 部门列表 |
data.users.departmentInfos.departmentId | string | HAP部门Id |
data.users.departmentInfos.departmentName | string | HAP部门名称 |
data.users.jobInfos | object[] | 职位列表 |
data.users.jobInfos.jobId | string | HAP职位Id |
data.users.jobInfos.jobName | string | HAP职位名称 |
curl -X GET "https://example.com/v2/user/getUsers?appKey=string&sign=string×tamp=0&projectId=string&pageIndex=0&pageSize=0&userStatus=0"{ "code": 0, "message": "string", "data": { "count": 0, "users": [ { "accountId": "string", "fullname": "string", "avatar": "string", "email": "string", "mobilePhone": "string", "contactPhone": "string", "jobNumber": "string", "lang": "string", "appLang": "string", "createTime": "string", "departmentInfos": [ { "departmentId": "string", "departmentName": "string" } ], "jobInfos": [ { "jobId": "string", "jobName": "string" } ] } ] }}