Update Application Authorization


Update the API authorization information of an application in a specified OU.

Prerequisites


The application of the service account already has the permission to update the authorization information of other applications. If necessary, contact the system administrator to obtain permission.

Request Format


POST https://{apigw-address}/app-portal-service/v2.3/app/authorization/set

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

appId

Required

String

The access key of the application. How to get Access Key >>

dataAuthorizeType

Required

Array

The updated API authorization list of the application. If the application already has authorization interfaces, the original authorization interfaces will be overwritten. The following values ​​are supported:

  • USER: Obtain the ID, username, email, and phone number of all users in the OU

  • ASSET: Obtain the ID and name of all assets in the OU

  • ROLE: Obtain the ID and name of all roles in the OU

  • USER_OP: Create or delete user accounts in the OU

  • USER_PERMISSION: Authorize users in the OU

  • USER_ALL_PERMISSION: Obtain all user permissions in the OU

  • ROLE_OP: Edit all roles in the OU

  • MENU_GROUP_OP: Edit all menu groups in the OU

Response Parameters


Name

Data Type

Description

data

boolean

Whether the app permissions are updated successfully. true indicates success, false indicates failure.

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

The application of the service account has no permission to authorize applications. Please contact the system administrator.

Samples

Request Sample


url: https://{apigw-address}/app-portal-service/v2.3/app/authorization/set
method: POST

requestBody:
{
  "appId": "your_access_key",
  "dataAuthorizeType":[
      "ROLE", "USER_OP", "ASSET", "USER"
  ]
}

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": true
}