Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Setting Pipeline Resource-Level Permissions for Different Roles

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Setting Pipeline Resource-Level Permissions for Different Roles

Function

This API is used to set pipeline resource-level permissions for different roles.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-permissions/pipeline/batch-role-permission

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
pipeline_ids	Yes	Array of strings	Pipeline ID list.
is_project_switch	Yes	Boolean	Whether to enable project permission configuration.
roles	Yes	Array of roles objects	Role details list.

**Table 3** roles
Parameter	Mandatory	Type	Description
operation_authorize	Yes	Boolean	Permission configuration permissions.
operation_delete	Yes	Boolean	Permission to delete.
operation_execute	Yes	Boolean	Permission to execute.
operation_query	Yes	Boolean	Permission to query.
operation_update	Yes	Boolean	Permission to update.
role_id	Yes	Integer	Role ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Status.

Example Requests

POST https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipeline-permissions/pipeline/batch-role-permission

{
  "pipeline_ids" : [ "53acae73a3f44b2994f9b20a710721c6", "146542db758a4dc0995b44dff13e1933" ],
  "is_project_switch" : false,
  "roles" : [ {
    "operation_authorize" : false,
    "operation_delete" : true,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : true,
    "role_id" : 3
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 4
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 5
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 6
  }, {
    "operation_authorize" : false,
    "operation_delete" : true,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : true,
    "role_id" : 7
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 8
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 9
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 500
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 501
  }, {
    "operation_authorize" : false,
    "operation_delete" : true,
    "operation_execute" : true,
    "operation_query" : true,
    "operation_update" : true,
    "role_id" : 502
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : true,
    "operation_update" : false,
    "role_id" : 503
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 504
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 505
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 506
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 507
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 508
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 509
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 510
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 511
  }, {
    "operation_authorize" : false,
    "operation_delete" : false,
    "operation_execute" : false,
    "operation_query" : false,
    "operation_update" : false,
    "role_id" : 512
  } ]
}