企业用户搜索

适用版本>=v7.0.2412b.20241226
接口说明：企业用户搜索

请求说明

请求地址	配置域名+/openapi+`/v7/users/search`
请求方法	GET
签名方式	KSO-1（配置域名+/openapi不参与签名）
权限要求	查询和管理通讯录信息（用户授权）`kso.contact.readwrite` 查询通讯录信息（用户授权）`kso.contact.read`

Header	参数类型	是否必填	说明
X-Kso-Date	string	是	RFC1123 格式的日期，例: `Wed, 23 Jan 2013 06:43:08 GMT`
X-Kso-Authorization	string	是	KSO-1 签名值，详见《签名方法》
Authorization	string	是	授权凭证，格式为：`Bearer {access_token}`

查询参数（Query）

名称	参数类型	是否必填	说明
keyword	string	是	搜索关键字
page_size	int64	是	分页大小，最小值：1，最大值：50
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回next_page_token作为新的page_token，下次遍历可采用该page_token获取查询结果；当查询结果中next_page_token为空或无该返回值时，代表无下一页。
status	string[]	否	用户状态，可选值： `active`:正常; `notactive`:未激活; `disabled`:禁用; `dimission`:离职; 格式为`status={string_1}&status={string_2}`
search_field_config_enabled	boolean	否	是否使用管理后台的字段搜索配置
search_source	string[]	否	搜索范围，可选值： `company_user`:本企业用户; `enterprise_partner`:关联组织成员; `external_contact`:外部联系人; 格式为`search_source={string_1}&search_source={string_2}` `external_contact`只支持单独指定

响应体（Response）

名称	类型	说明
code	int	错误码
detail	string	详细信息
msg	string	状态信息
data	object	返回信息体
∟ items	object[]	用户简单信息
∟ ∟ avatar	string	头像（url中不包含配置域名）
∟ ∟ ctime	integer	创建时间，时间戳，单位为秒
∟ ∟ email	string	邮箱
∟ ∟ ex_user_id	string	用户外部id,可以是用户ID、用户名、邮箱、手机号、外部ID、在外部身份源的ID，为空则默认为用户id
∟ ∟ high_light	object	高亮信息
∟ ∟ id	string	用户id,自动生成
∟ ∟ login_name	string	登录名
∟ ∟ phone	string	手机
∟ ∟ status	string	用户状态
∟ ∟ title	string	职务信息
∟ ∟ user_name	string	用户名
∟ ∟ def_dept_id	string	主部门id
∟ ∟ def_dept_name	string	主部门名称
∟ next_page_token	string	下一页分页标记，<= 1024 characters；当查询结果中next_page_token为空或无该返回值时，代表无下一页

响应体示例

json

{
  "code": 0,
  "detail": "string",
  "msg": "string",
  "data": {
    "items": [
      {
        "avatar": "/avatar/u/v1/avatar?name=dGVzdFsdw174563ib0w4bA==",
        "ctime": 0,
        "email": "user@example.com",
        "ex_user_id": "string",
        "high_light": {
          "string": ["string"]
        },
        "id": "string",
        "login_name": "string",
        "phone": "string",
        "status": "string",
        "title": "string",
        "user_name": "string",
        "def_dept_id": "string",
        "def_dept_name": "string"
      }
    ],
    "next_page_token": "string"
  }
}