Skip to content

根据邮箱获取用户

适用版本>=v7.0.2402.20240222

接口说明:根据邮箱获取用户信息

请求说明

请求地址配置域名+/graph+/v7/users/by_emails
请求方法POST
签名方式WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名)
权限要求通讯录查询(企业授权) kso.contacts.read

请求头(Header)

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间,示例: Wed,23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权凭证,格式为: Bearer {access_token}

请求体(Body)

名称类型是否必填说明
emailsstring[]用户邮箱,[ 1 .. 100 ] items [ items [ 1 .. 128 ] characters ]
statusstring[]Items Enum: "notactive" "active" "disabled",必填,可选值:active(正常),notactive(未激活),disabled(禁用)
with_deptbool是否返回部门信息

请求体示例

{
  "emails": [
    "string"
  ],
  "status": [
    "notactive"
  ],
  "with_dept": true
}

响应体(Response)

名称类型说明
codeintegercode
detailstringdetail
msgstringmsg
dataobject返回信息体
itemsobject[]用户简单信息
avatarstring头像
ctimeinteger创建时间,时间戳,单位为秒
deptsobject[]部门信息
abs_pathstring绝对路径
idstring部门id
namestring部门名称
emailstring邮箱,字符串长度不超过128位
employee_idstring工号
ex_user_idstring用户外部id,可以是用户ID、用户名、邮箱、手机号、外部ID、在外部身份源的ID,为空则默认为用户id
genderstringEnum: "secrecy" "male" "female",性别
idstring用户id,自动生成,字符串长度不超过128位
login_namestring登录名,字符串长度不超过128位
phonestring手机
statusstringEnum: "notactive" "active" "disabled",用户状态
telephonestring座机
titlestring职务信息,字符串长度不超过128位
user_namestring用户名称,字符串长度不超过128位
work_placestring办公地点
rolestring用户角色
super-admin:超级管理员;admin:普通管理员;normal:普通用户;

响应体示例

json
{
  "data": {
    "items": [
      {
        "avatar": "string",
        "ctime": 0,
        "depts": [
          {
            "abs_path": "string",
            "id": "string",
            "name": "string"
          }
        ],
        "email": "user@example.com",
        "employee_id": "string",
        "ex_user_id": "string",
        "gender": "secrecy",
        "id": "string",
        "login_name": "string",
        "phone": "string",
        "status": "notactive",
        "telephone": "string",
        "title": "string",
        "user_name": "string",
        "work_place": "string",
        "role": "string"
      }
    ]
  },
  "code": 0,
  "detail": "string",
  "msg": "string"
}