Get Role Permission¶

Get the menu groups, permissions, and visible organization structures assigned to a role.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/role/app/resource/assignedList

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	OU ID. How to get orgId >>

Request Parameters (Body)¶

Name

Required/Optional

Data Type

Description

roleId

Required

String

Role ID.

locale

Optional

String

Specifies the language in which to return the list information. The following values are supported:

en_US: English

zh_CN: Chinese

es_ES: Spanish

ja_JP: Japanese

de_DE: German

pl_PL: Polish

By default, the list information in English en_US is returned.

Response Parameters¶

Name	Data Type	Description
structures	RoleResourceDTO Struct	List of visible organization structures.
menuGroups	RoleResourceDTO Struct	List of menu groups.
permissions	RoleResourceDTO Struct	List of permissions.

RoleResourceDTO Struct¶

Name	Data Type	Description
resourceId	String	The ID of menu groups, permissions, or visible organization structures.
resourceName	String	The name of menu groups, permissions, or visible organization structures.
appId	String	The access key of the application to which menu groups, permissions, or visible organization structures belong.
appName	String	The name of the application to which menu groups, 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": "en_US"
}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": {
    "structures": [
        {
            "resourceId": "your_resource_id_1",
            "resourceName": "your_resource_name_1",
            "appId": "your_access_key_1",
            "appName": "your_app_name_1"
        }
    ],
    "menuGroups": [
        {
            "resourceId": "your_resource_id_2",
            "resourceName": "your_resource_name_2",
            "appId": "your_access_key_2",
            "appName": "your_app_name_2"
        },
        {
            "resourceId": "your_resource_id_3",
            "resourceName": "your_resource_name_3",
            "appId": "your_access_key_3",
            "appName": "your_app_name_3"
        }
    ],
    "permissions": [
        {
            "resourceId": "your_resource_id_4",
            "resourceName": "your_resource_name_4",
            "appId": "your_access_key_4",
            "appName": "your_app_name_4"
        }
    ]
  }
}