Get App Resources by User and Organization¶
Get the list of application permission points and menus
Operation Permissions¶
The OU has purchased the application
Users have the access to application menus and permission points
Request Format¶
GET https://{apigw-address}/app-portal-service/v2.3/user/app/resource/permission
Request Parameters (Query)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
orgId |
Mandatory |
String |
OU ID |
userId |
Mandatory |
String |
User ID |
appId |
Mandatory |
String |
Application ID |
locale |
Optional |
String |
Language code. English by default
|
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Data Struct |
List of Permission points and menus |
Data Struct¶
Name |
Data Type |
Description |
---|---|---|
permissions |
Permission List |
List of permission points |
menus |
Menu List |
List of menus |
Permission List¶
Name |
Data Type |
Description |
---|---|---|
id |
String |
Permission point ID |
code |
String |
Permission point code |
name |
String |
Permission point name |
Error Codes¶
Error Code |
Description |
---|---|
31400 |
Possible causes: OU ID, user name, and email are required, or the application is invalid |
31403 |
User does not have access to the application menus or permission points |
31404 |
Possible causes: non-existed OU or application, or application not purchased |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/user/app/resource/permission?orgId=o16304916513211484&appId=3f8e6c00-59ac-49c9-808f-40e951464b6c&userId=u16304951818651633
method: GET
Return Sample¶
{
"code": 0,
"message": "OK",
"data": {
"permissions": [
{
"id": "87a34031-0125-49e6-a455-a1f71eac2606",
"code": "DEL03_APP02_P01",
"name": "DEL03_APP02_P01"
}
],
"menus": [
{
"id": "ca89f6c1-d9f7-4632-b677-61cba104eba2",
"code": "DEL03_APP02_MENU01",
"name": "DEL03_APP02_MENU01",
"url": "",
"displayOrder": 1,
"parentId": "",
"sourceApp": null,
"children": [
{
"id": "49b3979e-58ab-4c92-9754-44aa285d0986",
"code": "DEL03_APP02_MENU01_01",
"name": "DEL03_APP02_MENU01_01",
"url": "/DEL03_APP02_MENU01_01.html",
"displayOrder": 1,
"parentId": "ca89f6c1-d9f7-4632-b677-61cba104eba2",
"sourceApp": null,
"children": []
},
{
"id": "ad7b6763-3b75-4d3c-923d-44faaf5e145f",
"code": "DEL03_APP02_MENU01_02",
"name": "DEL03_APP02_MENU01_02",
"url": "/DEL03_APP02_MENU01_02.html",
"displayOrder": 2,
"parentId": "ca89f6c1-d9f7-4632-b677-61cba104eba2",
"sourceApp": null,
"children": []
}
]
},
{
"id": "e7993dc1-effa-4a2d-9bf6-73ac605a4919",
"code": "DEL03_APP02_MENU03",
"name": "DEL03_APP02_MENU03",
"url": "/DEL03_APP02_MENU03.html",
"displayOrder": 3,
"parentId": "",
"sourceApp": null,
"children": []
}
]
}
}