Get User Base Info¶
根据用户邮箱、账号和域、或电话号码和电话区号获取用户的基本信息如用户 ID 等。
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
organizationId | 必需 | String | 组织 ID。如何获取 organizationId 信息>> |
可选 | String | 用户邮箱 | |
name | 可选 | String |
|
domain | 可选 | String |
|
phoneArea | 可选 | String |
|
phone | 可选 | String |
|
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
data | SimpleUserListDTO 结构体 | 用户基本信息的列表 |
SimpleUserDTO 结构体¶
名称 | 数据类型 | 描述 |
---|---|---|
id | String | 用户 ID |
name | String | 用户名 |
domain | String | 用户所属域 |
String | 用户邮箱 | |
department | String | 用户所属的部门 |
company | String | 用户所属的公司 |
position | String | 用户的职位 |
示例¶
请求示例¶
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"
}
]
}
}