常见问题
通讯录权限范围相关问题
调用通讯录接口需要哪些权限?
1.
2.
3.
为什么获取不到 user_id/邮箱/手机号等信息?
user_id
、邮箱和手机号等信息。通常,这是因为 user_id
、邮箱和手机号等信息比较敏感,需要单独申请相对的数据权限。这点在上一个问题中也阐明了,如果要获取和用户相关的敏感信息,需要申请对应的数据权限。详情也可以参考应用权限简介。user_accss_token 与 tenant_access_token 的权限差异是什么?
1.
tenant_access_token
基于应用的通讯录范围进行权限的过滤,如调用接口获取部门 A 时,会检查部门 A 是否在应用的通讯录权限范围内。其规则配置入口是Admin管理后台 > 工作台管理 > 应用管理。2.
user_accss_token
基于用户的可见组织架构范围来做权限过滤。用户可见的组织架构范围为 APP 端上 通讯录 > 组织架构 部分可见的信息。其规则配置入口在 Admin管理后台,进入安全 > 用户权限 > 组织架构可见范围 页面配置。如何获取企业全部员工信息?
1.
2.
parent_department_id=0
、fetch_child=true
,获取企业下所有部门 ID 列表。3.
如何获取根部门下的员工信息?
department_id=0
,获得根部门下的员工信息。用户 ID 相关问题
同一个用户在多个应用的 open_id 是一样的吗?
open_id
是用户在应用内唯一标识,因此同一个用户在不同应用中的 open_id
不一样。同一用户在不同企业的 open_id 和 union_id 是一样的吗?
user_id 能不能更新?
user_id
,若不指定将由系统自动为用户生成一个唯一的随机 ID 作为 user_id
。已创建用户的 user_id
(部分场景也叫 employee_id
)不支持更新,因为各应用方都可能用到并保存 user_id
, 如果修改 user_id
,可能造成应用感知不到,从而造成应用无法使用等问题。如何获取 user_id?
user_id
:用户/人员相关问题
误删了部门或者人员后能按照原有的 ID 恢复吗?
department_id
或者 user_id
。企业的 department_id
或者 user_id
是唯一的,建议新增一个 department_id
或者 user_id
。人员的 status 字段什么含义?
如何判断某个应用的用户是否也在使用“我”开发的其他应用?
union_id
,一个用户在同一个开发者所属的多个应用中,union_id
唯一。搜索用户接口为什么获取不到返回值?
page_token
的值是否正确。为什么不能通过手机号/邮箱获取其他人员信息?
人员什么时候会被自动拉入部门群?
被删除的用户的 user_id 会被后续新增的用户占用吗?
user_id
,业务方保存 user_id
,删除 A 员工之后,这个 user_id
会不会被后面新增的员工占用吗?user_id
可能会被新增的员工占用。系统默认生成的 user_id
,保证了企业内有效(无效表示已离职用户)用户唯一,开发者或管理员对用户进行删除,再添加,可能会存在新添加的用户的 user_id
和历史上已经删除的用户一样。所以建议增加用户的时候,用具有唯一性标示的 id 作为 user_id
,避免造成困扰。用户接口相关问题
如何理解用户属性中的自定义字段?
custom_attrs
属性是对用户属性的扩展,用于企业根据自身需求灵活扩展用户描述能力,根据取值语法的不同主要分为文本类型、网页类型、枚举类型、图片类型、用户类型。类型 | 描述 |
---|---|
文本类型 | 用户的 name 属性,只有一个 string 类型的 value。值对应 text 字段 |
网页类型 | 字段引用链接,可在成员名片页实现点击跳转效果。该类型字段需要有标题文字,值对应 text 字段,需要有跳转的 URL,值对应 url 。由于PC 端的跳转链接可能会和移动端不太一样,所以单独设置了 pc_url 作为跳转的 URL,如果该值不填,则 PC 端链接使用 url |
枚举类型 | 实现字段取值在给定选项中选择,如员工类型,包含正式、外包、顾问。企业成员的员工类型,只能在这些选项中选择,该类型的值对应 option_id ,也就是管理员配置的某个选项 key |
图片类型 | 与枚举类型相似,只是选项的数据类型只能是图片,用于在成员名片页展示其对应的图片,该类型的值对应 option_id ,可从管理后台查询对应的图片 id |
用户类型 | 该类型主要用于成员名片页展示对另一用户的引用,实现成员名片页之间的跳转,如将“张三”的 HRBP 字段显示“李四”并支持点击跳转至李四的名片页。对应generic_user 下 id 为需要引用的成员 user_id ,generic_user 下的 type 目前固定为1,表示用户类型 |
如何使用创建用户接口中的 enterprise_email 字段?
enterprise_email
字段表示设置用户的企业邮箱。如何理解获取用户列表接口?
department_id=0
表检查有没有根部门的通讯录权限,有的话,返回根部门下直属成员信息)。部门接口相关问题
如何获取父部门下所有员工的通讯录信息?
为什么获取到的 department_id 有的带 od-,有的不带?
department_id
,有时带有 "od-" 前缀,有时没有。department_id_type
,若没指定,默认是 open_department_id
,会带有 “od-”前缀。有关 department_id
的详细介绍,请参考通用参数。如何理解获取部门信息列表接口?
fetch_child
的取值来决定是否递归查询子部门信息。根部门的部门 ID 为 0,如果带上了 0,会校验是否有全员权限。错误排查
没有完全获取批量信息,但是提示执行成功
msg
也会返回 success
。这是因为:新增用户接口返回 email and mobile account conflict
email and mobile account conflict
,这个问题的原因是:新增用户接口返回 department id xxxxxxxx is not exist
department id xxxxxxxx is not exist
,请参考如下方法解决这个问题:department id
是否存在。open_department_id
。open_department_id
和 department_id
是两个不同的 ID。