Get Role Permission¶
Get the menu groups, operational permissions, and visible organization structures assigned to a role.
Request Parameters (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. |
locale | Optional | String | the language of the role name, English by default. - en_US for English - zh_CN for simplified Chinese - es_ES for Spanish - ja_JP for Japanese - de_DE for German |
Response Parameters¶
Name | Data Type | Description |
---|---|---|
data | data Struct | The menu groups, operational permissions, or visible organization structures assigned to the role. |
Data Struct¶
Name | Data Type | Description |
---|---|---|
structures | RoleResourceDTO Struct | List of visible organization structures. |
menuGroups | RoleResourceDTO Struct | List of menu groups. |
permissions | RoleResourceDTO Struct | List of operational permissions. |
RoleResourceDTO Struct¶
Name | Data Type | Description |
---|---|---|
resourceId | String | The ID of menu groups, operational permissions, or visible organization structures. |
resourceName | String | The name of menu groups, operational permissions, or visible organization structures. |
appId | String | The ID of the application to which menu groups, operational permissions, or visible organization structures belong. |
appName | String | The name of the application to which menu groups, operational permissions, or visible organization structures belong. |
Error Codes¶
Error Code | Description |
---|---|
31400 | OU ID are role ID are required. |
31404 | OU ID or role ID does not exist. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/role/app/resource/assignedList
method: POST
{
"roleId": "r12345667890",
"locale": "de_DE"
}
Return Sample¶
{
"code": 0,
"message": "OK",
"data": {
"structures": [
{
"resourceId": "your_resource_id_1",
"resourceName": "your_resource_name_1",
"appId": "your_app_id_1",
"appName": "your_app_name_1"
}
],
"menuGroups": [
{
"resourceId": "your_resource_id_2",
"resourceName": "your_resource_name_2",
"appId": "your_app_id_2",
"appName": "your_app_name_2"
},
{
"resourceId": "your_resource_id_3",
"resourceName": "your_resource_name_3",
"appId": "your_app_id_3",
"appName": "your_app_name_3"
}
],
"permissions": [
{
"resourceId": "your_resource_id_4",
"resourceName": "your_resource_name_4",
"appId": "your_app_id_4",
"appName": "your_app_name_4"
}
]
}
}