用户
批量同步用户
一次最多可同步500个用户。注意:公有云或平台版不支持
鉴权方式
HAP 组织授权开放接口为每个组织提供一套独立的密钥信息(AppKey 和 SecretKey),组织可通过此密钥信息安全调用 HAP 平台开放的各类接口,包括人员组织管理、汇报关系管理、应用管理、流程待办等数据接口。
版本
请求地址
Body 参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
appKey | string | 是 | AppKey |
sign | string | 是 | 签名 |
timestamp | integer | 是 | 时间戳 |
projectId | string | 是 | HAP组织Id |
users | object[] | 是 | 用户信息列表 |
users.corpUserId | string | 是 | 第三方用户Id |
users.name | string | 是 | 用户名 |
users.email | string | 否 | 邮箱,与 mobilePhone 不能同时为空 |
users.mobilePhone | string | 否 | 手机号,与 email 不能同时为空 |
users.password | string | 否 | 密码,不传或传空字符串时均不会修改原始密码(目前仅支持明文) |
users.contactPhone | string | 否 | 联系电话 |
users.jobNumber | string | 否 | 工号 |
users.departmentIds | string[] | 否 | 第三方部门Id列表 |
users.positions | string[] | 否 | 职位列表 |
users.emptyCover | boolean | 否 | 当 contactPhone、jobNumber、departmentIds、positions 为空时,是否覆盖原值,默认:true(覆盖) |
响应参数
200| 名称 | 类型 | 描述 |
|---|---|---|
code | integer | 状态码,1表示操作完成;非1表示操作异常,非1时data字段不存在 |
message | string | 状态描述 |
data | object[] | 用户关系列表 |
data.corpUserId | string | 第三方用户Id |
data.projectId | string | HAP组织Id |
data.accountId | string | HAP账号Id |
curl -X POST "https://example.com/v2/user/upsertUsers" \ -H "Content-Type: application/json" \ -d '{ "appKey": "string", "sign": "string", "timestamp": 0, "projectId": "string", "users": [ { "corpUserId": "string", "name": "string" } ] }'{ "code": 0, "message": "string", "data": [ { "corpUserId": "string", "projectId": "string", "accountId": "string" } ]}