批量获取用户信息

POST/v2/users/listByIds

根据用户 ID 列表批量获取账号信息。单次请求最多支持 100 个用户 ID。

Request

Query parameters

$select string

请求体参数

ids string[]

待查询的用户 id 列表

响应

users object[]

id 对应的列表，不存在的 id 不返回

id string

用户 id，

email stringrequired

展示使用的邮件地址，只能设置为别名列表其中之一

emailAliases string[]

邮件地址别名列表

name stringrequired

用户名(人名)

nickname string

用户昵称(或者花名)

defaultSendEmail string

默认发信邮箱（可选字段：在URL中增加$select=defaultSendEmail查询参数后返回，如需多个字段使用英文逗号分隔）

employeeNo string

工号

jobTitle string

职位

workLocation string

工作地

officeLocation string

工位

homeLocation string

居住地（可选字段：在URL中增加$select=homeLocation查询参数后返回，如需多个字段使用英文逗号分隔）

departmentIds string[]required

用户所属的部门(列表)，非部门链，用户可能同时隶属多个部门

phone string

手机号（可选字段：在URL中增加$select=phone查询参数后返回，如需多个字段使用英文逗号分隔）

workPhone string

工作电话（可选字段：在URL中增加$select=workPhone查询参数后返回，如需多个字段使用英文逗号分隔）

status enum

帐号状态（仅正常或冻结），仅管理员或授权应用可修改

• NORMAL: 正常
• FREEZE: 被冻结

Possible values: [NORMAL, FREEZE]

avatar object

头像

url string

头像地址

bgColor string

头像地址空时，背景色值，示例: #0089ff

createdTime string<date-time>

创建时间

freezedTime string<date-time>

冻结时间，管理员或授权应用可读取（可选字段：在URL中增加$select=freezedTime查询参数后返回，如需多个字段使用英文逗号分隔）

preferredLanguage string

语言偏好(ISO 639-1 Code, 如 zh_CN/zh_TW/en_US)（可选字段：在URL中增加$select=preferredLanguage查询参数后返回，如需多个字段使用英文逗号分隔）

modifiedTime string<date-time>

修改时间

statusChangeReason string

帐号状态变化原因，仅管理员或授权应用可修改（可选字段：在URL中增加$select=statusChangeReason查询参数后返回，如需多个字段使用英文逗号分隔）

customName string

自定义展示名，发邮件时展示的名字

managerInfo object

主管详情（可选字段：在URL中增加$select=managerInfo查询参数后返回，如需多个字段使用英文逗号分隔）

id string

主管id

email string

主管邮件地址

name string

姓名

nickname string

昵称

managerEmail string

主管 email，可写（可选字段：在URL中增加$select=managerEmail查询参数后返回，如需多个字段使用英文逗号分隔）

departmentPath object

归属的部门链，如果归属多个部门，则包含多个部门链（可选字段：在URL中增加$select=departmentPath查询参数后返回，如需多个字段使用英文逗号分隔）

paths object[]

部门链

segments string[]

部门节点

enableClientPassword boolean

是否启用了专属密码（可选字段：在URL中增加$select=enableClientPassword查询参数后返回，如需多个字段使用英文逗号分隔）

lastLoginTime string<date-time>

上次登录时间（可选字段：在URL中增加$select=lastLoginTime查询参数后返回，如需多个字段使用英文逗号分隔）

lastPasswordChangeTime string<date-time>

上次密码修改时间，（可选字段：在URL中增加$select=lastPasswordChangeTime查询参数后返回，如需多个字段使用英文逗号分隔）

isInitialPassword boolean

是否初始密码（可选字段：在URL中增加$select=isInitialPassword查询参数后返回，如需多个字段使用英文逗号分隔）

isHidden boolean

是否从通讯录中隐藏，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=isHidden查询参数后返回，如需多个字段使用英文逗号分隔）

lastLoginIp string

上次登录ip（可选字段：在URL中增加$select=lastLoginIp查询参数后返回，如需多个字段使用英文逗号分隔）

info string

信息备注，仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=info查询参数后返回，如需多个字段使用英文逗号分隔）

forceChangePasswordNextSignIn boolean

下次登录是否要强制修改密码，仅管理员或授权应用可修改（可选字段：在URL中增加$select=forceChangePasswordNextSignIn查询参数后返回，如需多个字段使用英文逗号分隔）

employeeType enum

帐号类型。（可选字段：在URL中增加$select=employeeType查询参数后返回，如需多个字段使用英文逗号分隔）

• EMPLOYEE: 雇员
• CONTRACTOR: 外包
• INTERN: 实习生
• SERVICE: 共享帐号
• WORK_ACCOUNT: WORK_ACCOUNT

Possible values: [EMPLOYEE, CONTRACTOR, INTERN, SERVICE, WORK_ACCOUNT]

passwordExpireTime string<date-time>

密码过期时间（可选字段：在URL中增加$select=passwordExpireTime查询参数后返回，如需多个字段使用英文逗号分隔）

lastLoginTime4StandardProtocol string<date-time>

上次登录时间(标准协议)（可选字段：在URL中增加$select=lastLoginTime4StandardProtocol查询参数后返回，如需多个字段使用英文逗号分隔）

orderInDepartments object[]

账号在不同部门下的排序值，必须提供全量部门的排序值数据。该字段会影响账号在其他部门的排序，一般场景优先使用设置单个部门排序值的接口。例如账号归属部门a、b、c，账号原只有部门c的排序值。更新账号在该字段传入部门a和b的排序值后，账号将只有部门a和b的排序值，原有部门c的排序值将丢失。仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=orderInDepartments查询参数后返回，如需多个字段使用英文逗号分隔）

departmentId string

order string

customFields object

用户添加的自定义字段值，支持部分修改，无需传入全量字段值。仅自己、管理员或授权应用可修改，可通过 $select=customFields 进行整体读取。否则只能通过 $select=customFields.字段ID 的形式读取公开字段的值。

property name* string

用户添加的自定义字段值，支持部分修改，无需传入全量字段值。仅自己、管理员或授权应用可修改，可通过 $select=customFields 进行整体读取。否则只能通过 $select=customFields.字段ID 的形式读取公开字段的值。

错误

401	访问未授权，请检查是否传递了正确的授权token
403	无API访问权限，请在域管的应用管理页面完成相关授权