- Documentation
- User and Organization
- Get Application Authorization
Get Application Authorization¶
Get the API authorization information of an application in a specified OU.
Request Format¶
GET https://{apigw-address}/app-portal-service/v2.3/app/authorization/info
Request Parameters (Query)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
orgId |
Mandatory |
String |
OU ID. |
appId |
Mandatory |
String |
Application ID. |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
data Struct |
The information of application API authorization. |
Data Struct¶
Name |
Data Type |
Description |
---|---|---|
dataAuthorizeType |
Array |
The list of API authorization items, which might contain the following authorization IDs: - USER for “Obtain the ID, username, email, and phone number of all users in the OU” - ASSET for “Obtain the ID and name of all assets in the OU” - ROLE for “Obtain the ID and name of all roles in the OU” - USER_OP for “Create or delete user accounts in the OU” - USER_PERMISSION for “Authorize users in the OU” - USER_ALL_PERMISSION for “Obtain all user permissions in the OU” - ROLE_OP for “Edit all roles in the OU” - MENU_GROUP_OP for “Edit all menu groups in the OU” |
Error Codes¶
Error Code |
Description |
---|---|
31400 |
Possible reasons are: - OU ID is required. - authorization type is invalid. - The target application is an application shortcut. - OU has no permission to access the application. |
31403 |
Service account has no permission to authorize applications. |
Samples¶
Request Sample¶
url: https://{apigw-address}/app-portal-service/v2.3/app/authorization/info
method: GET
{
"orgId": "your_org_id",
"appId": "your_app_id"
}
Return Sample¶
{
"code": 0,
"message": "OK",
"data": {
"dataAuthorizeType":[
"ROLE", "USER_OP", "ASSET", "USER"
]
}
}