Querying the Diagnosis Result of the Data Permission Control Module

Function

This API is used to query the diagnosis result of the data permission control module.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/diagnose/permission-management

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
X-Auth-Token	Yes	String	IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	Diagnosis task ID
check_time	Long	Last check time
scanning	Boolean	Whether a diagnosis is in progress
high_permission	HighPermission object	Diagnosis result of high privilege management
unreasonable_permission	UnreasonablePermission object	Permission control rationality check result

**Table 4** HighPermission
Parameter	Type	Description
result	String	detection results NO_RISK MEDIUM_RISK HIGH_RISK NOT_SCANNED
workspace_admin	String	Workspace administrators
security_administrator	String	Security administrators

**Table 5** UnreasonablePermission
Parameter	Type	Description
result	String	detection results NO_RISK MEDIUM_RISK HIGH_RISK NOT_SCANNED
count	Integer	Number of risky permission control configurations

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

/v1/0833a5737480d53b2f25c010dc1a7b88/security/diagnose/permission-management

Example Responses

Status code: 200

{
  "check_time" : 1703488426000,
  "high_permission" : {
    "result" : "MEDIUM_RISK",
    "security_administrator" : "user1,user2,user3",
    "workspace_admin" : "user1,user2,user3"
  },
  "scanning" : false,
  "task_id" : "6f28400297cc4402adfb13ce7533f996",
  "unreasonable_permission" : {
    "count" : 7,
    "result" : "MEDIUM_RISK"
  }
}