Get Users by Role¶
获取拥有特定角色的用户列表。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.3/role/user/assignedList
请求参数(Query)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
orgId |
必需 |
String |
组织 ID。 |
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
roleId |
必需 |
String |
角色 ID。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
Data 结构体 |
角色列表。 |
Data 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
users |
user 结构体 |
用户列表。 |
user 结构体¶
名称 |
数据类型 |
描述 |
---|---|---|
userId |
String |
用户名 ID。 |
name |
String |
用户名。 |
String |
用户邮箱。 |
|
phone |
String |
手机号码。 |
phoneArea |
String |
手机号码所属区号。 |
错误码¶
代码 |
描述 |
---|---|
31400 |
缺少必要参数。 |
31404 |
角色不存在,或本 OU 未获取此应用。 |
示例¶
请求示例¶
url: /app-portal-service/v2.3/role/user/assignedList?orgId=your_org_ID
method: POST
{
"roleId": "your_role_ID"
}
返回示例¶
{
"code": 0,
"message": "OK",
"data": {
"users": [
{
"userId": "your_user_ID",
"email": "your_user_email",
"phone": "",
"phoneArea": "",
"name": "your_user_name"
}
]
}
}