获取所有用户信息
用于第三方应用获取一批用户的信息。
说明:配置第三方应用为授信应用的时候需要勾选上更新组织架构。
#调用说明
请求方式: POST
请求url:/api/trustedapp/getUsers
请求参数示例:
{
"appid": "5rc6t7vyb8u9nimpo",
"app_secret": "q3zw4xe5cr68vt79by80un9ie5r6ctv7yb8uio",
"userDirectory": "sys",
"orgId":"4200000",
"deptId":"hlc",
"modifiedAfter":1600748892721
}
参数说明:
| 参数 | 必须 | 说明 |
|---|---|---|
| appid | 是 | 授信应用ID |
| app_secret | 是 | 授信应用秘钥 |
| userDirectory | 否 | 用户类型,sys代表系统用户,external代表外部用户,默认为sys |
| orgId | 否 | 所属机构,用来查询某个机构下面的用户 |
| deptId | 否 | 所属部门,用来查询某个部门下面的用户 |
| modifiedAfter | 否 | 修改时间晚于,时间戳长整型。用来查询某个时间之后有修改的用户,包括新增、修改、删除的用户,查询条件为[修改时间]>modifiedAfter |
modifiedAfter 说明(以OA系统为例说明,OA系统调用本接口获取用户):
- 可以使用这个参数实现用户的准实时同步。比如OA系统每隔10分钟调用一次
getUsers接口,获取新的有变化的用户。 modifiedAfter参数应该指定为OA系统自己的用户库中的用户的最大修改时间。说明,getUsers会返回最后修改时间,第一次可以从用户库中取最大修改时间,后面可以取前一次的getUsers返回的lastModifyTime。- 注意当指定
modifiedAfter参数时,会将这个时间点之后删除的用户也返回,通过deleteFlag可以判断用户是否已删除。没有指定modifiedAfter参数时,只会返回正常的用户,不包含删除的用户。
#返回值说明
示例:
{
"errorCode": "appNotFound",
"message": "app 不存在",
"lastModifyTime": 1600748892721,
"users": [{
"userId": "342112",
"userName": "张三",
"phone": "13112345678",
"email": "xxx@email.com",
"deptId" : "development",
"avatar": "http://example.com/api/avatar/xxx",
"createTime":1600748812345,
"modifyTime":1600748892721,
"deleteFlag": 0
}]
}
参数说明:
| 参数 | 说明 |
|---|---|
| errorCode | 错误码 |
| message | 错误文本提示 |
| lastModifyTime | 返回的这批用户的最大修改时间 |
| user.userId | 用户ID |
| user.userName | 用户昵称 |
| user.phone | 手机号 |
| user.email | 邮件地址 |
| user.deptId | 所在部门的ID |
| user.avatar | 头像地址 |
| user.createTime | 创建时间 |
| user.modifyTime | 修改时间,新创建的用户修改时间等于创建时间 |
| user.deleteFlag | 删除标记,1代表用户已删除,0代表用户正常 |
errorCode 说明:
| errorCode | 说明 |
|---|---|
| appNotFound | 应用不存在 |
| appDisabled | 应用被禁用了 |
| secretMismatch | 应用秘钥被禁用了 |