Get Users by Role¶
Get the list of users with the specified roles.
Request Parameter (Query)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
orgId | Mandatory | String | OU ID |
Request Parameters (Body)¶
Name | Mandatory/Optional | Data Type | Description |
---|---|---|---|
roleId | Mandatory | String | Role ID |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | Data Struct | List of roles |
User Struct¶
Name | Data Type | Description |
---|---|---|
userId | String | User ID |
name | String | User name |
String | User email | |
phone | String | Phone number |
phoneArea | String | The area code of phone number |
Error Codes¶
Error Code | Description |
---|---|
31400 | Required parameters are missing |
31404 | the role does not exist, or the OU does not acquire the application |
Samples¶
Request Sample¶
url: /app-portal-service/v2.3/role/user/assignedList?orgId=your_org_ID
method: POST
{
"roleId": "your_role_ID"
}
Return Sample¶
{
"code": 0,
"message": "OK",
"data": {
"users": [
{
"userId": "your_user_ID",
"email": "your_user_email",
"phone": "",
"phoneArea": "",
"name": "your_user_name"
}
]
}
}