Get Application Authorization


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

Prerequisites


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

Request Format


GET https://{apigw-address}/app-portal-service/v2.3/app/authorization/info

Request Parameters (URI)


Name

Location (Path/Query)

Required/Optional

Data Type

Description

orgId

Query

Required

String

OU ID. How to get orgId >>

appId

Query

Required

String

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

Response Parameters


Name

Data Type

Description

dataAuthorizeType

Array

The assigned API authorization list of the application. The correspondence between ID and permission is as follows:

  • 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

The application of the service account has no permission to authorize applications.

Samples

Request Sample


url: https://{apigw-address}/app-portal-service/v2.3/app/authorization/info?orgId=your_org_ID&appId=your_access_key
method: GET

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": {
    "dataAuthorizeType":[
      "ROLE", "USER_OP", "ASSET", "USER"
    ]
  }
}