Help Center/ DataArts Insight/ API Reference/ Dataset Permissions/ Obtaining Dataset Permission Configuration Information

Updated on 2025-02-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining Dataset Permission Configuration Information

Function

This API is used to obtain dataset permission configuration information.

URI

GET /v1/{project_id}/datasets/{dataset_id}/permission-config

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
dataset_id	Yes	String	Dataset ID.
project_id	Yes	String	Project ID. For how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Workspace-Id	Yes	String	Workspace ID. For how to obtain it, see Obtaining a Workspace ID.
X-Auth-Token	Yes	String	User token.
Content-Type	Yes	String	Request body type and character set, which have fixed values.

Response Parameters

**Table 3** Response body parameters
Parameter	Type	Description
row_permission_config	object	Row permission configuration. For details, see Table 4.
col_permission_config	object	Column permission configuration. For details, see Table 5.

**Table 4** row_permission_config
Parameter	Type	Description
is_open	Boolean	Whether to enable row permissions.
is_open_by_condition	Boolean	Whether to enable condition combination authorization.
others_has_permission_by_condition	Boolean	Permissions of other users (not specified in the authorization for combined row conditions).
is_open_by_tag	Boolean	Additional configuration for row and column permissions, indicating whether to enable authorization for combined row conditions.

**Table 5** col_permission_config
Parameter	Type	Description
is_open	Boolean	Whether to enable column permissions.

Example Request

GET https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permission-config

Example Response

{
  "row_permission_config" : {
    "is_open" : true,
    "is_open_by_condition" : true,
    "others_has_permission_by_condition" : false,
    "is_open_by_tag" : true
  },
  "col_permission_config" : {
    "is_open" : true
  }
}