批量获取脱敏的用户登录信息

该接口用于查询用户的登录信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/passport/v1/sessions/query
HTTP Method	POST
接口频率限制	10 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	passport:session_mask:readonly 获取用户登录信息（mask）
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
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

请求体

名称	类型	必填	描述
user_ids	string\[\]	否	用户 ID 示例值：["47f621ff"] 数据校验规则： - 最大长度：100

请求体示例

{"user_ids":["7aeddb6a1","7aeddb6a2","7aeddb6a3"]}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ mask_sessions	mask_session\[\]	用户登录信息
└ create_time	string	创建时间
└ terminal_type	int	客户端类型 可选值有： - 0: 未知 - 1: 个人电脑 - 2: 浏览器 - 3: 安卓手机 - 4: Apple手机 - 5: 服务端 - 6: 旧版小程序端 - 8: 其他移动端
└ user_id	string	用户ID
└ sid	string	需要登出的 session 标识符

响应体示例

{
    "code":0,
    "data":{
        "mask_sessions":[
            {
                "create_time":"1644980493",
                "terminal_type":2,
                "user_id":"47f183f1f1",
                "sid":"ABBAAAAAAANll6nQoIAAFA=="
            },
            {
                "create_time":"1644983127",
                "terminal_type":2,
                "user_id":"47f183ff1",
                "sid":"ACCAAAAAAANll6nQoIAAFA=="
            },
            {
                "create_time":"1644983127",
                "terminal_type":2,
                "user_id":"47f183ff2",
                "sid":"BBBAAAAAAANll6nQoIAAFA=="
            }
        ]
    },
    "msg":""
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1080001	param is invalis	参数无效