Help Center/ DataArts Studio/ API Reference/ DataArts Security APIs/ Permission Management/ Querying Table Permissions
Updated on 2025-11-17 GMT+08:00
View PDF

Querying Table Permissions

Function

This API is used to query table permissions.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/member-permission/{user_id}

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.

user_id

Yes

String

IAM user ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

feature

Yes

String

Permission list scenario type. The value is PERMISSION_LIST.

limit

No

Integer

Number of items displayed on each page

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

datasource_type

No

String

Data source type. The value can be hive, dli, or dws.

cluster_name

No

String

Cluster name

database_name

No

String

Database name

schema_name

No

String

Schema name

table_name

No

String

Table name

fuzzy_table_name

No

String

Table name (fuzzy match)

workspace_ids

No

Array of strings

Workspace IDs

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of permissions

member_permission_list

Array of MemberPermission objects

Member permissions (including those in the permission set and approved permissions)
Table 5 MemberPermission

Parameter

Type

Description

permission_set_id

String

Permission set ID.

permission_source

String

Permission source, which can be a permission set name or approved permission

permission_actions

String

Permission type. The value can be ALL, SELECT, UPDATE, CREATE, DROP, ALTER, INDEX, LOCK, READ, or WRITE.

url

String

Policy information of the URL permission for the Hive data source

datasource_type

String

Data source type

cluster_name

String

Cluster name

database_name

String

Database name

schema_name

String

Schema name

table_name

String

Table name

column_name

String

Column name

Example Requests

None

Example Responses

Status code: 200

ok

{
  "total" : 1,
  "member_permission_list" : [ {
    "database_name" : "dls",
    "datasource_type" : "HIVE",
    "schema_name" : null,
    "table_name" : "dls_hive_samples_101",
    "column_name" : "test_column",
    "cluster_name" : "mrs_cluster",
    "permission_actions" : "SELECT",
    "permission_set_id" : null,
    "permission_source" : "Permission review",
    "url" : null
  } ]
}

Status Codes

Status Code

Description

200

ok
Parent Topic: Permission Management