Get App Resources by User and Organization¶

Get the list of application permission points and menus

Operation Permissions¶

The OU has acquired 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. If unspecified, it is set to English by default. en_US for English zh_CN for Simplified Chinese es_ES for Spanish ja_JP for Japanese `de_DE` for German `pl_PL` for Polish

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

Menu List¶

Name	Data Type	Description
id	String	Menu ID
name	String	Menu name
code	String	Menu code
displayOrder	Integer	Menu display order, indicating the order of the current menu in a specified menu level. The value is an integer starting with 1, where the menus appear by smallest to largest value
url	String	Menu URL
parentId	String	Parent menu
children	Menu Struct	Sub-menu

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 acquired

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/user/app/resource/permission?orgId=your_org_id&appId=your_app_id&userId=your_user_id

method: GET

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "permissions": [
            {
                "id": "your_resource_id",
                "code": "your_resource_code",
                "name": "your_resource_name"
            }
        ],
        "menus": [
            {
                "id": "your_menu_id",
                "code": "your_menu_code",
                "name": "your_menu_name",
                "url": "",
                "displayOrder": 1,
                "parentId": "",
                "sourceApp": null,
                "children": [
                    {
                        "id": "your_menu_id",
                        "code": "your_menu_code",
                        "name": "your_menu_name",
                        "url": "your_menu_url",
                        "displayOrder": 1,
                        "parentId": "your_parent_menu_id",
                        "sourceApp": null,
                        "children": []
                    },
                    {
                        "id": "your_menu_id",
                        "code": "your_menu_code",
                        "name": "your_menu_name",
                        "url": "your_menu_url",
                        "displayOrder": 2,
                        "parentId": "your_parent_menu_id",
                        "sourceApp": null,
                        "children": []
                    }
                ]
            },
            {
                "id": "your_menu_id",
                "code": "your_menu_code",
                "name": "your_menu_name",
                "url": "your_menu_url",
                "displayOrder": 3,
                "parentId": "",
                "sourceApp": null,
                "children": []
            }
        ]
    }
}