Querying the Privilege Set List

Function

This API is used to query the permission set list.

Calling Method

For details, see Calling APIs.

URI

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

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

**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.
name	No	String	Name.
parent_id	No	String	Parent permission set ID.
type_filter	No	String	Permission set type filtering. The value is TOP_PERMISSION_SET,SUB_PERMISSION_SET,ALL_PERMISSION_SET.
manager_id	No	String	Administrator ID.
manager_name	No	String	Administrator name.
manager_type	No	String	Administrator type. The options are USER and USER_GROUP.
datasource_type	No	String	Data Source Type Hive data source DWS Data Source DLI Data Source
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 NAME, CREATE_TIME, and UPDATE_TIME.
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.
permission_sets	Array of PermissionSet objects	Permission set list

**Table 5** PermissionSet
Parameter	Type	Description
id	String	Indicates the ID.
parent_id	String	Parent permission set ID.
name	String	Name.
description	String	Description.
type	String	Permission set type. The options are COMMON and MRS_MANAGED.
managed_cluster_id	String	ID of the cluster to which the managed role belongs (required only for management permission sets).
managed_cluster_name	String	Name of the cluster to which the role to be managed belongs (required only for management permission sets).
project_id	String	Project ID
domain_id	String	Indicates the tenant ID.
instance_id	String	Instance ID.
manager_id	String	Administrator ID.
manager_name	String	Administrator name.
manager_type	String	Administrator type.
datasource_type	String	Data source type.
sync_status	String	Synchronization status. The value is UNKNOWN,NOT_SYNC,SYNCING,SYNC_SUCCESS,SYNC_FAIL.
sync_msg	String	Synchronization information.
sync_time	Long	Synchronize the time.
create_time	Long	Creation time.
create_user	String	Creator.
update_time	Long	Update time.
update_user	String	Updater.

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?offset=0&limit=10&type_filter=TOP_PERMISSION_SET

Example Responses

Status code: 200

{
  "permission_sets" : [ {
    "create_time" : 1698202688000,
    "create_user" : "ei_dayu_test_01",
    "datasource_type" : null,
    "description" : "test permission set",
    "domain_id" : "0833a5736980d53b0f22c0102ffcbfc0",
    "id" : "fea96c90024711b8bf8d6886407b814b",
    "instance_id" : "dd97167b873d4a79b2aad54d4370a3bc",
    "managed_cluster_id" : null,
    "managed_cluster_name" : null,
    "manager_id" : "b43927a45a514e93ba70524b28923500",
    "manager_name" : "common_user",
    "manager_type" : "USER",
    "name" : "test_permission_set",
    "parent_id" : "0",
    "project_id" : "0833a5737480d53b2f25c010dc1a7b88",
    "sync_msg" : null,
    "sync_status" : "NOT_SYNC",
    "sync_time" : null,
    "type" : "COMMON",
    "update_time" : 1698202688000,
    "update_user" : "ei_dayu_test_01"
  } ],
  "total" : 1
}