Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts Security API Overview
Updated on 2025-11-17 GMT+08:00

DataArts Security API Overview

Table 1 DataArts Security API types

Type

Description

Permission Management

Permission management APIs

Identification Rule

Identification rule APIs

Rule Group

Rule group APIs

Data Permission Query

Data permission query APIs

Data Security Level

Data security level APIs

Permission Applications

Permission application APIs

Sensitive Data Distribution

Sensitive data distribution APIs

User Synchronization

User synchronization APIs

Queue Permissions

Queue permissions APIs

Data Classification

Data classification APIs

Data Security Diagnosis

Data security diagnosis APIs

Workspace Resource Permission Policy Management

Workspace resource permission policy management APIs

Security Administrator

Security administrator APIs

Dynamic Data Masking

Dynamic data masking APIs

Permission Approval

Permission approval APIs

Permission Application

Permission application APIs

Permission Management

Table 2 Permission management

API

Description

Creating a Permission Set

This API is used to create a permission set.

Querying the Permission Set List

This API is used to query the permission set list.

Querying a Permission Set

This API is used to query a permission set.

Deleting a Permission Set

This API is used to delete a permission set.

Updating a Permission Set

This API is used to update a permission set.

Adding a Member to a Permission Set

This API is used to add a member to a permission set.

Querying Members of a Permission Set

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

Adding Members to a Permission Set

This API is used to add members to a permission set.

Deleting Members of a Permission Set

This API is used to delete members of a permission set.

Adding Permissions to a Permission Set

This API is used to add permissions to a permission set.

Querying Permissions in a Permission Set

This API is used to query the permissions in a permission set.

Deleting Permissions from a Permission Set

This API is used to delete permissions from a permission set.

Updating Permissions in a Permission Set

This API is used to update the permissions in a permission set.

Querying Permissions Available for a Data Source

This API is used to query the permissions available for a data source.

Querying the URL Information Configured in a Permission Set

This API is used to query the URL information configured in a permission set, for example, the URL paths in components such as OBS and HDFS.

Querying Data Operations

This API is used to query data operations.

Querying a User's Permissions on a Table

This API is used to query a user's permissions on a table.

Querying Table Permissions

This API is used to query table permissions.

Identification Rule

Table 3 Identification Rule

API

Description

Querying the Identification Rule List

This API is used to query the identification rule list.

Creating an Identification Rule

This API is used to create an identification rule.

Querying a Specified Identification Rule

This API is used to query a specified identification rule.

Deleting an Identification Rule

This API is used to delete an identification rule.

Modifying an Identification Rule

This API is used to modify an identification rule.

Deleting Identification Rules

This API is used to delete identification rules.

Modifying the Identification Rule Status

This API is used to modify the identification rule status.

Creating a Combined Identification Rule

This API is used to create a combined identification rule.

Modifying a Combined Identification Rule

This API is used to modify a combined identification rule.

Testing a Combined Identification Rule

This API is used to test a combination identification rule.

Rule Group

Table 4 Rule group

API

Description

Querying the Rule Group List

This API is used to query the rule group list.

Creating a Rule Group

This API is used to create a rule group.

Querying a Rule Group

This API is used to query a rule group.

Modifying a Rule Group

This API is used to modify a rule group.

Deleting a Rule Group

This API is used to delete a rule group.

Data Permission Query

Table 5 Data permission query

API

Description

Querying the Configurable Operation Permission of a Role on a Group of Databases and Tables

This API is used to query the configurable operation permissions of a role on a group of databases and tables.

Data Security Level

Table 6 Data security level

API

Description

Obtaining a Data Security Level

This API is used to obtain a data security level.

Creating a Data Security Level

This API is used to create a data security level.

Querying the Data Security Level with a Specified ID

This API is used to query the data security level with a specified ID.

Deleting the Data Security Level with a Specified ID

This API is used to delete a data security level with a specified ID.

Changing the Data Security Level with a Specified ID

This API is used to change the data security level with a specified ID.

Deleting Data Security Levels

This API is used to delete data security levels.

Permission Applications

Table 7 Permission application

API

Description

Querying the Fine-grained Data Development Connection List

This API is used to query the fine-grained data development connection list.

Updating the Fine-grained Authentication Status of Data Development Connections

This API is used to update the fine-grained authentication status of data development connections.

Testing Fine-grained Connectivity of Data Development Connections

This API is used to test the fine-grained connectivity of data development connections.

Sensitive Data Distribution

Table 8 Sensitive data distribution

API

Description

Querying the Sensitive Data Discovery Overview Result (by Category and Security Level)

This API is used to query the sensitive data discovery overview result (by category and security level).

User Synchronization

Table 9 User synchronization

API

Description

Querying User Synchronization Tasks

This API is used to query user synchronization tasks.

Querying a User Synchronization Task

This API is used to query a specified user synchronization task.

Queue Permissions

Table 10 Queue permissions

API

Description

Querying Queues Allocated to the Current Workspace

This API is used to query the queues allocated to the current workspace.

Allocating Queues to a Workspace

This API is used to allocate queues to a specified workspace.

Modifying a Queue in the Current Workspace

This API is used to modify a queue in the current workspace.

Deleting a Queue from the Current Workspace

This API is used to delete a queue from the current workspace.

Data Classification

Table 11 Data classification

API

Description

Importing Preset Classifications

This API is used to import preset classifications.

Querying the Data Classification List

This API is used to query the data classification list.

Data Security Diagnosis

Table 12 Data security diagnosis

API

Description

Diagnosing Data Security

This API is used to diagnose data security.

Querying Improper Permission Configurations

This API is used to query improper permission configurations.

Querying the Diagnosis Result of the Data Permission Control Module

This API is used to query the diagnosis result of the data permission control module.

Querying the Diagnosis Result of the Sensitive Data Protection Module

This API is used to query the diagnosis result of the sensitive data protection module.

Querying the Tables for Which No Static Masking Task Has Been Performed

This API is used to query the tables for which no static masking task has been performed.

Querying the Diagnosis Result of the Data Source Protection Module

This API is used to query the diagnosis result of the data source protection module.

Workspace Resource Permission Policy Management

Table 13 Workspace Resource Permission Policy Management

API

Description

Querying Workspace Resource Permission Policies

This API is used to query workspace resource permission policies.

Creating a Workspace Resource Permission Policy

This API is used to create a workspace resource permission policy.

Querying a Workspace Resource Permission Policy

This API is used to query a workspace resource permission policy.

Updating a Workspace Resource Permission Policy

This API is used to update a workspace resource permission policy.

Deleting Workspace Resource Permission Policies

This API is used to delete workspace resource permission policies.

Security Administrator

Table 14 Security administrator

API

Description

Obtaining the Security Administrator

This API is used to obtain the security administrator.

Creating or Updating a Security Administrator

This API is used to create or update a security administrator.

Dynamic Data Masking

Table 15 Dynamic data masking

API

Description

Querying Dynamic Data Masking Policies

This API is used to query dynamic data masking policies.

Creating a Dynamic Data Masking Policy

This API is used to create a dynamic data masking policy.

Querying Details of a Data Masking Policy

This API is used to query the details of a data masking policy.

Updating a Dynamic Data Masking Policy

This API is used to update a dynamic data masking policy.

Deleting Dynamic Masking Policies

This API is used to delete dynamic masking policies.

Permission Approval

Table 16 Permission approval

API

Description

Obtaining Table Permission Reviewers

This API is used to obtain the list of table permission reviewers.

Submitting a Table Permission Application

This API is used to submit a table permission application.

Approving a Service Ticket

This API is used to approve a service ticket.

Rejecting a Service Ticket

This API is used to reject a service ticket.

Obtaining the Approval Service Ticket List

This API is used to obtain the list of approval service tickets.

Approving Service Tickets

This API is used to approve service tickets.

Rejecting Service Tickets

This API is used to reject service tickets.

Permission Application

Table 17 Permission application

API

Description

Withdrawing a Permission Application Service Ticket

This API is used to withdraw a permission application service ticket.