查询企业下所有用户

适用版本>=v7.0.2411a.20241114
接口说明：查询用户对象列表

标签：通讯录

请求说明

字段	值
请求地址	配置域名+/openapi+`/v7/users`
HTTP 方法	`GET`
接口描述	查询用户对象列表
签名方式	KSO-1（配置域名+/openapi不参与签名）
限频策略	无
权限要求	查询和管理通讯录信息(应用授权) `kso.contact.readwrite` 查询通讯录信息(应用授权) `kso.contact.read`

请求头 (Headers)

属性名	类型	是否必填	描述	可选值
X-Kso-Id-Type	`string`	否	类型 * internal - 内部 * external - 外部	`internal`, `external`
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)

属性名	类型	是否必填	描述	可选值
page_size	`integer`	否	分页大小，默认为：10，最大值：50	-
page_token	`string`	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果	-
with_total	`boolean`	否		-
with_dept	`boolean`	否		-
status	`array`	是	必填项，可选值：active(正常)，notactive(未激活)，disabled(禁用)	`active`, `notactive`, `disabled`, `dimission`

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json

{
  "data": {
    "items": [
      {
        "avatar": "string",
        "ctime": 0,
        "depts": [
          {
            "abs_path": "string",
            "dept_id": "string",
            "name": "string"
          }
        ],
        "email": "string",
        "employee_id": "string",
        "employment_status": "string",
        "employment_type": "string",
        "ex_user_id": "string",
        "gender": "string",
        "id": "string",
        "leader_id": "string",
        "login_name": "string",
        "phone": "string",
        "role": "string",
        "source": "inner",
        "status": "string",
        "telephone": "string",
        "title": "string",
        "type": "company_user",
        "user_name": "string",
        "work_place": "string"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "code": 0,
  "msg": "string"
}