查询指定用户
适用版本>=v7.0.2411a.20241114
接口说明:基于user_id查询指定用户
标签:通讯录
请求说明
| 字段 | 值 |
|---|---|
请求地址 | 配置域名+/openapi+/v7/users/{user_id} |
HTTP 方法 | GET |
接口描述 | 基于user_id查询指定用户(调用 创建用户 接口后可从返回结果中获取到用户id;有诸多查询用户信息的API可获取部门id字段,如 获取当前用户信息),仅支持获取当前企业用户信息,仅支持应用身份 |
签名方式 | 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} | - |
路径参数 (Path)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
user_id | string | 是 | 用户id,长度范围[1,128] | - |
查询参数 (Query)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|---|---|---|---|---|
with_dept | boolean | 否 | 是否需要返回部门信息,可选值:true(返回部门信息),false(不返回部门信息),默认为false | - |
响应体(Response)
HTTP状态码: 200
响应体格式: application/json
没有可用的数据
响应体示例
json
{
"data": {
"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"
},
"code": 0,
"msg": "string"
}