Querying the Permission List of a Permission Set

Function

This API is used to query the permission list of a permission set.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/permission-sets/{permission_set_id}/permissions

**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.
permission_set_id	Yes	String	Permission set ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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.
permission_type	No	String	Permission type. The options are DENY and ALLOW.
permission_action	No	String	Permission operation, ALL,SELECT,UPDATE,CREATE,DROP,ALTER,INDEX,LOCK,READ,WRITE
cluster_id	No	String	Cluster ID. For details about how to obtain the cluster ID, see Querying Information About a Single Data Connection.
cluster_name	No	String	Cluster Name
datasource_type	No	String	Data Source Type Hive data source DWS Data Source DLI Data Source
database_name	No	String	Database name
table_name	No	String	Table name
column_name	No	String	Column name.
sync_status	No	String	Synchronization status. The value is UNKNOWN,NOT_SYNC,SYNCING,SYNC_SUCCESS,SYNC_FAIL.
order_by	No	String	Sorting parameter. The options are CLUSTER_NAME and DATABASE_NAME.
order_by_asc	No	Boolean	Indicates whether to sort data in ascending order. This parameter is valid only when the sorting parameter is specified.

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	Specifies the total number of events.
permissions	Array of PermissionSetPermission objects	List of permissions

**Table 5** PermissionSetPermission
Parameter	Type	Description
id	String	id.
permission_set_id	String	Permission set ID.
project_id	String	Project ID.
instance_id	String	Instance ID.
permission_type	String	Permission type. The options are DENY and ALLOW.
permission_action	String	Permission operation list.
permission_actions	Array of strings	Permission operation list.
permission_action_code	Integer	Permission operation code, which is a bitmap.
cluster_id	String	Cluster ID
cluster_name	String	Cluster name
datasource_type	String	Data source type: Hive data source DWS Data Source DLI Data Source
database_name	String	Database name.
schema_name	String	Specifies the schema name.
namespace	String	Namespace
table_name	String	Table name
column_name	String	Column name.
row_level_security	String	Row-level policy.
sync_status	String	Synchronization status. The value is UNKNOWN,NOT_SYNC,SYNCING,SYNC_SUCCESS,SYNC_FAIL.
sync_msg	String	Synchronization information.
url	String	URL

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/permission-sets/fea96c90024711b8bf8d6886407b814b/permissions?offset=0&limit=10

Example Responses

Status code: 200

{
  "permissions" : [ {
    "cluster_id" : "4367f185-79d4-41ae-afd5-54d55176aa68",
    "cluster_name" : "mrs_3x_autotest_do_not_del",
    "column_name" : "*",
    "database_name" : "default",
    "datasource_type" : "HIVE",
    "id" : "511fe36e2cc0e33a094a8bdaa4b73e55",
    "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc",
    "namespace" : null,
    "permission_action" : "SELECT",
    "permission_action_code" : 2,
    "permission_actions" : [ "SELECT" ],
    "permission_set_id" : "fea96c90024711b8bf8d6886407b814b",
    "permission_type" : "ALLOW",
    "project_id" : "0833a5737480d53b2f25c010dc1a7b88",
    "row_level_security" : null,
    "schema_name" : null,
    "sync_msg" : null,
    "sync_status" : "NOT_SYNC",
    "table_name" : "*"
  } ],
  "total" : 1
}