根据 ex_user_id 获取用户信息
根据 ex_user_id 获取用户信息
请求说明
请求地址 | https://openapi.wps.cn/v7/users/by_ex_user_ids |
---|---|
请求方法 | POST |
签名方式 | KSO-1 |
权限要求 | 查询和管理通讯录信息(应用授权) kso.contact.readwrite 查询通讯录信息(应用授权) kso.contact.read |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
请求体(Body)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
ex_user_ids | array[string] | 是 | |
status | array[string] | 是 | 用户状态,必填。active :正常;notactive :未激活;disabled :禁用 |
请求地址示例
[POST] https://openapi.wps.cn/v7/users/by_ex_user_ids
请求体示例
json
{
"ex_user_ids": ["string"],
"status": ["string"]
}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | 用户信息列表 |
∟ ∟ avatar | string | 头像 |
∟ ∟ ctime | integer | 创建时间 |
string | 邮箱 需额外获取字段权限:查询用户的邮箱(应用授权) kso.user_email.read | |
∟ ∟ ex_user_id | string | 用户外部 id,可以是用户 id、用户名、邮箱、手机号、外部 id、在外部身份源的 id,为空则默认为用户 id |
∟ ∟ id | string | 用户 id,自动生成 |
∟ ∟ phone | string | 手机号码 需额外获取字段权限:查询用户的手机号(应用授权) kso.user_phone.read |
∟ ∟ role | string[enum] | 用户角色 super-admin :超级管理员;admin :普通管理员;normal :普通用户 |
∟ ∟ status | string[enum] | 用户状态 active :正常;notactive :未激活;disabled :禁用;dimission :离职 |
∟ ∟ title | string | 职务信息 |
∟ ∟ user_name | string | 用户名称 |
响应体示例
json
{
"data": {
"items": [
{
"avatar": "string",
"ctime": 0,
"email": "string",
"ex_user_id": "string",
"id": "string",
"phone": "string",
"role": "string[enum]",
"status": "string[enum]",
"title": "string",
"user_name": "string"
}
]
},
"msg": "string",
"code": 0
}