Query User Menus

Queries the menu tree of a user.

Request URL

GET {base_url}/uc-user/api/v1/user-permissions/menus

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code No String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Query parameters
Parameter Required Type Description
userId Yes String The ID of the user. You can obtain the ID using the Search Resellers interface.
applicationId Yes Integer The ID of the application.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Array<Menu_Tree_Node> The menu tree of the user.
Menu_Tree_Node
Parameter Type Description
id String The ID of the menu.
parentId String The ID of the parent menu.
name String The name of the menu.
code String The code of the menu.
path String The path of the menu.
icon String The icon of the menu.
type Integer

The type of the menu:

  • 0: Directory.
  • 1: Menu.
  • 2: Button.
sortOrder Integer The sort order of the menu.
status Boolean Whether the menu is enabled.
permissionIds Array<Integer> The list of permission IDs of the menu.
children Array<Menu_Tree_Node> The list of child menus. The structure of a child node is the same as the structure of this table (recursive).

Example

Request example

GET /uc-user/api/v1/user-permissions/menus?userId=2085315948849827842&applicationId=1 HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwiYXBwX2tleSI6Im9icWJUSWd1ZkJ5d3ZCNmF0VURmVDZpeDJvUlhUb0wzIiwiZ3JhbnRfdHlwZSI6Im9wZW5hcGkiLCJjbGllbnRfZXh0Ijp7ImRlc2NyaXB0aW9uIjoi56ys5LiJ5pa55ZCI5L2c5LyZ5Ly05bqU55SoIiwicGFydG5lciI6IuekuuS-i-WQiOS9nOS8meS8tCJ9LCJjbGllbnRfdHlwZSI6Im9wZW5hcGkiLCJleHAiOjE3OTIwNzI3NTcsImlhdCI6MTc5MjA1MTE1NywianRpIjoiOTVkOGM1YWMtNzg3MS00ZjlmLWFiOWUtYzFjOTBlYzU4N2M1IiwiY2xpZW50X2lkIjoibm92by1vcGVuLXBsYXRmb3JtIiwidXNlcl9leHQiOnsicm9sZUlkcyI6WzNdLCJzdHlwZSI6IkFETUlOIiwidGVuYW50Q29kZSI6bnVsbCwidHlwZSI6IlBfQUNDT1VOVCIsInVzZXJJZCI6MjA4NTMxNTk0ODg0OTgyNzg0MiwiZW1haWwiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidXNlcm5hbWUiOiJtdDEwMDBAbWFpbHN0YXIudG9wIiwidWNJZCI6MjA4NTMxNTk0ODI4Nzc5MTEwNn19.AmC_hWm0Pa51VbO2YaQZF3gXofw5NQDi_njH-fPAi2r_kWc8PyxkK6vq212lTPHR-eDMY3CaXhUxptGNcUUXAHfbuFqHXBcLvZ1ggmMCYLlSpcsj9TBg3BULyvHOlJBEbO7b_OOBZi_fGG-Oe3e9m-EsdOjA150ZJKU9trq-QUqFndTvdMZV9JHDV2xpDwgKdT6v4xNhM9TaAT9_tLmOtSipIijx32ng8CIDd0l7jWYfrmwsjf32n0P232nXmKfdADjSuKAp8TNxc17ccFxt9k0aQlB9uyhGPjIdCHSK7hill2VbzVAGuVzj3b1AplQz2cAVmVhXqWqOfpfjM1tY9A

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "id": "1001",
      "name": "Dashboard",
      "code": "platform:dashboard",
      "path": "/platform/dashboard",
      "icon": "DashboardOutlined",
      "type": 2,
      "sortOrder": 1,
      "status": true,
      "children": [],
      "permissionIds": []
    }
  ],
  "requestId": "cae02b2b72a65fc4043164dcba7cbf23",
  "code": "200",
  "message": "SUCCESS"
}
Note:

The response is condensed. The result array contains 10 items.