Help Center/ DataArts Insight/ API Reference/ Dataset Permissions/ Enabling or Disabling Dataset Permissions
Updated on 2025-02-25 GMT+08:00

Enabling or Disabling Dataset Permissions

Function

This API is used to enable or disable dataset permissions.

URI

POST /v1/{project_id}/datasets/{dataset_id}/permissions/config

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

dataset_id

Yes

String

Dataset 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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

col_permission_config

No

object

Column permission configuration. For details, see Table 4.

row_permission_config

No

object

Row permission configuration. For details, see Table 5.

Table 4 ColPermissionConfig

Parameter

Mandatory

Type

Description

is_open

No

Boolean

Whether to enable column permissions.

Table 5 RowPermissionConfig

Parameter

Mandatory

Type

Description

is_open

No

Boolean

Whether to enable row permissions.

is_open_by_condition

No

Boolean

Whether to enable condition combination authorization.

is_open_by_tag

No

Boolean

Additional configuration for row and column permissions, indicating whether to enable authorization for combined row conditions.

others_has_permission_by_condition

No

Boolean

Permissions of other users (not specified in the authorization for combined row conditions).

Response Parameters

Table 6 Response body parameters

Parameter

Type

Description

data

Boolean

Whether the request is successful.

Example Request

POST https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permissions/config
{
  "row_permission_config" : {
    "is_open" : true
  }
}

Example Response

{
  "data" : true
}

Status Codes

Table 7 Status code

Status Code

Description

200

The permissions are successfully updated.

Error Codes

See Error Codes.