获取用户列表

使用该接口获取智能门禁中所有用户信息。

Warning: 只能获取已加入智能门禁权限组的用户。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/acs/v1/users
HTTP Method	GET
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	acs:users 查看、更新智能门禁用户
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小 示例值：10 数据校验规则： - 最大值：50
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值："10"
user_id_type	string	否	用户 ID 类型 示例值："open_id" 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	user\[\]	-
└ feature	feature	用户特征
└ card	int	卡号
└ face_uploaded	boolean	是否已上传人脸图片
└ user_id	string	用户 ID
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "feature": {
                    "card": 123456,
                    "face_uploaded": true
                },
                "user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62"
            }
        ],
        "page_token": "AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1490018	page token is invalid error	重新获取 page token