ContactService.User (larksuite-oapi 2.0.6 API)

java.lang.Object
- com.lark.oapi.service.contact.v3.ContactService.User

封闭类:: ContactService

public static class ContactService.User
extends Object

构造器概要

构造器
构造器和说明

User(Config config)

构造器
构造器和说明
`User(Config config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BatchGetIdUserResp`	`batchGetId(BatchGetIdUserReq req)` 通过手机号或邮箱获取用户 ID，通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
`BatchGetIdUserResp`	`batchGetId(BatchGetIdUserReq req, RequestOptions reqOptions)` 通过手机号或邮箱获取用户 ID，通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
`CreateUserResp`	`create(CreateUserReq req)` 创建用户，使用该接口向通讯录创建一个用户，可以理解为员工入职。
`CreateUserResp`	`create(CreateUserReq req, RequestOptions reqOptions)` 创建用户，使用该接口向通讯录创建一个用户，可以理解为员工入职。
`DeleteUserResp`	`delete(DeleteUserReq req)` 删除用户，该接口向通讯录删除一个用户信息，可以理解为员工离职。
`DeleteUserResp`	`delete(DeleteUserReq req, RequestOptions reqOptions)` 删除用户，该接口向通讯录删除一个用户信息，可以理解为员工离职。
`FindByDepartmentUserResp`	`findByDepartment(FindByDepartmentUserReq req)` 获取部门直属用户列表，基于部门ID获取部门直属用户列表。
`FindByDepartmentUserResp`	`findByDepartment(FindByDepartmentUserReq req, RequestOptions reqOptions)` 获取部门直属用户列表，基于部门ID获取部门直属用户列表。
`GetUserResp`	`get(GetUserReq req)` 获取单个用户信息，该接口用于获取通讯录中单个用户的信息。
`GetUserResp`	`get(GetUserReq req, RequestOptions reqOptions)` 获取单个用户信息，该接口用于获取通讯录中单个用户的信息。
`ListUserResp`	`list(ListUserReq req)` ，官网API文档链接:	`ListUserResp`	`list(ListUserReq req, RequestOptions reqOptions)` ，官网API文档链接:	`PatchUserResp`	`patch(PatchUserReq req)` 修改用户部分信息，该接口用于更新通讯录中用户的字段，未传递的参数不会更新。
`PatchUserResp`	`patch(PatchUserReq req, RequestOptions reqOptions)` 修改用户部分信息，该接口用于更新通讯录中用户的字段，未传递的参数不会更新。
`UpdateUserResp`	`update(UpdateUserReq req)` 更新用户所有信息，该接口用于更新通讯录中用户的字段。
`UpdateUserResp`	`update(UpdateUserReq req, RequestOptions reqOptions)` 更新用户所有信息，该接口用于更新通讯录中用户的字段。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - User
```
public User(Config config)
```
- 方法详细资料
  - batchGetId
```
public BatchGetIdUserResp batchGetId(BatchGetIdUserReq req,
                                     RequestOptions reqOptions)
                              throws Exception
```
    通过手机号或邮箱获取用户 ID，通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
    如果查询的手机号、邮箱不存在，或者无权限查看对应的用户，则返回的用户ID列表为空。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/BatchGetIdUserSample.java ;
    
    抛出:
    
    Exception
  - batchGetId
```
public BatchGetIdUserResp batchGetId(BatchGetIdUserReq req)
                              throws Exception
```
    通过手机号或邮箱获取用户 ID，通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
    如果查询的手机号、邮箱不存在，或者无权限查看对应的用户，则返回的用户ID列表为空。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/batch_get_id ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/BatchGetIdUserSample.java ;
    
    抛出:
    
    Exception
  - create
```
public CreateUserResp create(CreateUserReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    创建用户，使用该接口向通讯录创建一个用户，可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
    - 新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户，如果想要在根部门下新增用户，必须要有全员权限。;- 应用商店应用无权限调用此接口。;- 创建用户后，会给用户发送邀请短信/邮件，用户在操作同意后才可访问团队。;- 返回数据中不返回手机号，如果需要请重新查询用户信息获取手机号。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/CreateUserSample.java ;
    
    抛出:
    
    Exception
  - create
```
public CreateUserResp create(CreateUserReq req)
                      throws Exception
```
    创建用户，使用该接口向通讯录创建一个用户，可以理解为员工入职。创建用户后只返回有数据权限的数据。具体的数据权限的与字段的对应关系请参照[应用权限](https://open.feishu.cn/document/ukTMukTMukTM/uQjN3QjL0YzN04CN2cDN)。
    - 新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户，如果想要在根部门下新增用户，必须要有全员权限。;- 应用商店应用无权限调用此接口。;- 创建用户后，会给用户发送邀请短信/邮件，用户在操作同意后才可访问团队。;- 返回数据中不返回手机号，如果需要请重新查询用户信息获取手机号。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/CreateUserSample.java ;
    
    抛出:
    
    Exception
  - delete
```
public DeleteUserResp delete(DeleteUserReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    删除用户，该接口向通讯录删除一个用户信息，可以理解为员工离职。
    - 若用户归属部门A、部门B，应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。;- 应用商店应用无权限调用接口。;- 用户可以在删除员工时设置删除员工数据的接收者，如果不设置则由其leader接收，如果该员工没有leader，则会将该员工的数据删除。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/DeleteUserSample.java ;
    
    抛出:
    
    Exception
  - delete
```
public DeleteUserResp delete(DeleteUserReq req)
                      throws Exception
```
    删除用户，该接口向通讯录删除一个用户信息，可以理解为员工离职。
    - 若用户归属部门A、部门B，应用的通讯录权限范围必须包括部门A和部门B才可以删除用户。;- 应用商店应用无权限调用接口。;- 用户可以在删除员工时设置删除员工数据的接收者，如果不设置则由其leader接收，如果该员工没有leader，则会将该员工的数据删除。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/delete ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/DeleteUserSample.java ;
    
    抛出:
    
    Exception
  - findByDepartment
```
public FindByDepartmentUserResp findByDepartment(FindByDepartmentUserReq req,
                                                 RequestOptions reqOptions)
                                          throws Exception
```
    获取部门直属用户列表，基于部门ID获取部门直属用户列表。
    - 部门ID 必填，根部门的部门ID为0。;- 使用 `user_access_token` 情况下根据个人组织架构的通讯录可见范围进行权限过滤，返回个人组织架构通讯录范围（[登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility)）内可见的用户数据。;- 使用`tenant_access_token`会根据应用通讯录的范围进行权限过滤。如果请求的部门ID为0，则校验应用是否具有全员通讯录权限；如果是非0的部门ID，则会验证应用是否具有该部门的通讯录权限。无权限返回无权限错误码，有权限则返回对应部门下的直接用户列表。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/FindByDepartmentUserSample.java ;
    
    抛出:
    
    Exception
  - findByDepartment
```
public FindByDepartmentUserResp findByDepartment(FindByDepartmentUserReq req)
                                          throws Exception
```
    获取部门直属用户列表，基于部门ID获取部门直属用户列表。
    - 部门ID 必填，根部门的部门ID为0。;- 使用 `user_access_token` 情况下根据个人组织架构的通讯录可见范围进行权限过滤，返回个人组织架构通讯录范围（[登录企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility)）内可见的用户数据。;- 使用`tenant_access_token`会根据应用通讯录的范围进行权限过滤。如果请求的部门ID为0，则校验应用是否具有全员通讯录权限；如果是非0的部门ID，则会验证应用是否具有该部门的通讯录权限。无权限返回无权限错误码，有权限则返回对应部门下的直接用户列表。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/find_by_department ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/FindByDepartmentUserSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetUserResp get(GetUserReq req,
                       RequestOptions reqOptions)
                throws Exception
```
    获取单个用户信息，该接口用于获取通讯录中单个用户的信息。
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/GetUserSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetUserResp get(GetUserReq req)
                throws Exception
```
    获取单个用户信息，该接口用于获取通讯录中单个用户的信息。
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/get ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/GetUserSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListUserResp list(ListUserReq req,
                         RequestOptions reqOptions)
                  throws Exception
```
    ，
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=user&version=v3 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListUserSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListUserResp list(ListUserReq req)
                  throws Exception
```
    ，
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=user&version=v3 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListUserSample.java ;
    
    抛出:
    
    Exception
  - patch
```
public PatchUserResp patch(PatchUserReq req,
                           RequestOptions reqOptions)
                    throws Exception
```
    修改用户部分信息，该接口用于更新通讯录中用户的字段，未传递的参数不会更新。
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/PatchUserSample.java ;
    
    抛出:
    
    Exception
  - patch
```
public PatchUserResp patch(PatchUserReq req)
                    throws Exception
```
    修改用户部分信息，该接口用于更新通讯录中用户的字段，未传递的参数不会更新。
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/patch ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/PatchUserSample.java ;
    
    抛出:
    
    Exception
  - update
```
public UpdateUserResp update(UpdateUserReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    更新用户所有信息，该接口用于更新通讯录中用户的字段。
    应用需要拥有待更新用户的通讯录授权，如果涉及到用户部门变更，还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UpdateUserSample.java ;
    
    抛出:
    
    Exception
  - update
```
public UpdateUserResp update(UpdateUserReq req)
                      throws Exception
```
    更新用户所有信息，该接口用于更新通讯录中用户的字段。
    应用需要拥有待更新用户的通讯录授权，如果涉及到用户部门变更，还需要同时拥有所有新部门的通讯录授权。应用商店应用无权限调用此接口。 ;
    官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/update ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UpdateUserSample.java ;
    
    抛出:
    
    Exception

类 ContactService.User

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

User

方法详细资料

batchGetId

batchGetId

create

create

delete

delete

findByDepartment

findByDepartment

get

get

list

list

patch

patch

update

update