Get User Base Info¶

根据以下信息获取用户的基本信息如用户 ID 等：

用户邮箱
用户名和域
电话号码和电话区号

前提条件¶

应用需拥有“获取本 OU 内所有用户 ID、账号、邮箱、手机号码”的权限。如有需要，联系 OU 管理员获取权限。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/user/getUserBaseInfo

请求参数（Body）¶

在下列请求参数中，除 organizationId 外，必须至少指定 1 个参数，才可返回结果。若都不指定，将不返回任何结果。若同时指定多个，查找的优先顺序依次为：

email
name 和 domain
phone 和 phoneArea

名称	必需/可选	数据类型	描述
organizationId	必需	String	OU ID。如何获取 organizationId 信息 >>
email	可选	String	用户邮箱。
name	可选	String	用户名。若用户账号为域账号，必须同时指定 `domain` 参数。
domain	可选	String	域名称。当用户账号为域账号时可指定，且必须同时指定 `name` 参数。
phoneArea	可选	String	电话区号。如需指定，必须同时指定 `phone` 参数。
phone	可选	String	电话号码。如需指定，必须同时指定 `phoneArea` 参数。

响应参数¶

名称	数据类型	描述
users	SimpleUserDTO 结构体	用户基本信息的列表。SimpleUserDTO 结构体 >>

SimpleUserDTO 结构体 ¶

名称	数据类型	描述
id	String	用户 ID。
name	String	用户名。
domain	String	用户所属域。
email	String	用户邮箱。
department	String	用户所属的部门。
company	String	用户所属的公司。
position	String	用户的职位。
accountStartTime	String	用户账号开始生效的时间。
accountExpireTime	String	用户账号的过期时间。
updatedTime	String	用户账号的更新时间。

错误码¶

代码	描述
31400	参数错误，参数不能为空等
31403	应用未被授予“获取本 OU 内所有用户 ID、账号、邮箱、手机号码”的权限
31404	未找到 OU、用户等

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/user/getUserBaseInfo

method: POST

requestBody:
{"organizationId":"yourOrgId", "email":"yourEmail"}

返回示例¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "users": [
      {
        "id": "your_user_id",
        "name": "your_user_name",
        "domain": "",
        "email": "your_user_email",
        "company": "your_user_company",
        "position": "your_user_position",
        "department": "your_user_department",
        "updatedTime": "2024-09-11 17:42:22",
        "accountStartTime": "",
        "accountExpireTime": ""

      }
    ]
  }
}