服务端 API/通讯录/用户/概述
# 用户 User 资源概述
## 资源定义
Lark某个企业里的一个用户。
## 字段说明
名称 | 类型 | 描述
---|---|---
user_id | string | 租户内用户的唯一标识，该值可以自定义也可以由系统随机生成。详细定义参见[什么是 User ID](https://open.larksuite.com/document/home/user-identity-introduction/user-id)；获取方式参见[如何获得 User ID、Open ID 和 Union ID](https://open.larksuite.com/document/home/user-identity-introduction/how-to-get)
**自定义`user_id`数据校验规则**：
- 最大长度：`64` 字符
- 正则校验：不能包含空格字
**示例值**："u273y71"
**字段权限要求**：
获取用户 user ID
open_id | string | 租户内用户的唯一标识，详细定义参见[什么是 Open ID](https://open.larksuite.com/document/home/user-identity-introduction/open-id)；获取方式参见[如何获得 User ID、Open ID 和 Union ID](https://open.larksuite.com/document/home/user-identity-introduction/how-to-get)
**示例值**："ou_7dab8a3d3cdcc9da365777c7ad535d62"
union_id | string | 租户内用户的唯一标识，详细定义参见[什么是 Union ID](https://open.larksuite.com/document/home/user-identity-introduction/introduction)；获取方式参见[如何获得 User ID、Open ID 和 Union ID](https://open.larksuite.com/document/home/user-identity-introduction/how-to-get)
**示例值**："on_cad4860e7af114fb4ff6c5d496d1dd76"
name | string | 用户名
**示例值**："张三"
**数据校验规则**：
- 最小长度：`1` 字符
**字段权限要求（满足任一）**：
获取用户基本信息
以应用身份读取通讯录
en_name | string | 英文名
**示例值**："San Zhang"
**字段权限要求（满足任一）**：
获取用户基本信息
以应用身份读取通讯录
email | string | 邮箱
**示例值**："zhangsan@gmail.com"
**字段权限要求**：
获取用户邮箱信息
mobile | string | 手机号
**示例值**："13011111111"
**字段权限要求**：
获取用户手机号
mobile_visible | boolean | 手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码
**示例值**：false
gender | int | 性别
**示例值**：1
**可选值有**：
- `0`：保密
- `1`：男
- `2`：女
**字段权限要求（满足任一）**：
获取用户性别
以应用身份读取通讯录
avatar_key | string | 头像的文件Key，可通过“消息与群组/消息/图片信息”中的“上传图片”接口上传并获取头像文件 Key
**示例值**："2500c7a9-5fff-4d9a-a2de-3d59614ae28g"
department_ids | string\[\] | 用户所属部门的ID列表
**示例值**：od-4e6ac4d14bcd5071a37a39de902c7141
leader_user_id | string | 用户的直接主管的用户ID
**示例值**："ou_7dab8a3d3cdcc9da365777c7ad535d62"
city | string | 城市
**示例值**："杭州"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
country | string | 国家或地区缩写Code，[具体对应列表](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/country-code-description)
**示例值**："CN"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
work_station | string | 工位
**示例值**："北楼-H34"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
join_time | int | 入职时间
**示例值**：2147483647
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
employee_no | string | 工号
**示例值**："1"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
employee_type | int | 员工类型，可选值有：
- 1：正式员工
- 2：实习生
- 3：外包
- 4：劳务
- 5：顾问
同时可读取到自定义员工类型的 int 值，可通过下方接口获取到该租户的自定义员工类型的名称
[获取人员类型](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)
**示例值**：1
orders | user_order\[\] | 用户排序信息
∟ department_id | string | 排序信息对应的部门ID
**示例值**："od-4e6ac4d14bcd5071a37a39de902c7141"
∟ user_order | int | 用户在其直属部门内的排序，数值越大，排序越靠前
**示例值**：100
∟ department_order | int | 用户所属的多个部门间的排序，数值越大，排序越靠前
**示例值**：100
custom_attrs | user_custom_attr\[\] | 自定义字段
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
∟ type | string | 自定义字段类型
- `TEXT`
- `HREF`
- `ENUMERATION`
- `PICTURE_ENUM`
- `GENERIC_USER`
**示例值**："TEXT"
∟ id | string | 自定义字段ID
**示例值**："DemoId"
∟ value | user_custom_attr_value | 自定义字段取值, [相关问题](https://open.larksuite.com/document/ugTN1YjL4UTN24CO1UjN/uQzN1YjL0cTN24CN3UjN)
∟ text | string | 字段类型为 TEXT 时该参数定义字段值，字段类型为 HREF 时该参数定义网页标题
**示例值**："DemoText"
∟ url | string | 字段类型为 HREF 时，该参数定义默认 URL
**示例值**："http://www.larksuite.com"
∟ pc_url | string | 字段类型为 HREF 时，该参数定义PC端 URL
**示例值**："http://www.larksuite.com"
∟ option_id | string | 字段类型为 ENUMERATION 或 PICTURE_ENUM 时，该参数定义选项值
**示例值**："edcvfrtg"
∟ generic_user | custom_attr_generic_user | 字段类型为 GENERIC_USER 时，该参数定义引用人员
∟ id | string | 用户的user_id
**示例值**："9b2fabg5"
∟ type | int | 用户类型 1：用户
**示例值**：1
enterprise_email | string | 企业邮箱，请先确保已在管理后台启用Lark邮箱服务
**示例值**："demo@mail.com"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
job_title | string | 职务
**示例值**："xxxxx"
**字段权限要求（满足任一）**：
获取用户雇佣信息
以应用身份读取通讯录
need_send_notification | boolean | 是否发送提示消息
**示例值**：false
### 数据示例
```json
{
"user_id": "u273y71",
"open_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
"union_id": "ou_be2c1742f2bb189469bdd33f0b1516ea",
"name": "张三",
"en_name": "San Zhang",
"email": "zhangsan@gmail.com",
"mobile": "13011111111",
"mobile_visible": false,
"gender": 1,
"avatar_key": "2500c7a9-5fff-4d9a-a2de-3d59614ae28g",
"department_ids": [
"od-4e6ac4d14bcd5071a37a39de902c7141"
],
"leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
"city": "杭州",
"country": "CN",
"work_station": "北楼-H34",
"join_time": 2147483647,
"employee_no": "1",
"employee_type": 1,
"orders": [
{
"department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
"user_order": 100,
"department_order": 100
}
],
"custom_attrs": [
{
"type": "TEXT",
"id": "DemoId",
"value": {
"text": "DemoText",
"url": "http://www.larksuite.com",
"pc_url": "http://www.larksuite.com",
"option_id": "edcvfrtg",
"generic_user": {
"id": "9b2fabg5",
"type": 1
}
}
}
],
"enterprise_email": "demo@mail.com",
"job_title": "xxxxx",
"need_send_notification": false,
"notification_option": {
"channels": [
"sms"
],
"language": "zh-CN"
}
}
```
## 用户ID说明
了解`user_id`,`open_id`,`union_id`的区别和用途，参见教程 [用户相关的 ID 概念](https://open.larksuite.com/document/home/user-identity-introduction/introduction)