Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Modifying Pipeline Role Permissions
Updated on 2025-03-25 GMT+08:00

Modifying Pipeline Role Permissions

Function

This API is used to modify pipeline role permissions.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-permissions/{pipeline_id}/update-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.

pipeline_id

Yes

String

Parameter description:

Pipeline 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_id

No

String

Pipeline ID.

operation_query

Yes

Boolean

Permission to query.

operation_execute

Yes

Boolean

Permission to execute.

operation_update

Yes

Boolean

Permission to edit.

operation_delete

Yes

Boolean

Permission to delete.

operation_authorize

Yes

Boolean

Permission configuration permissions.

role_id

Yes

Integer

Role ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Status.

Example Requests

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-permissions/0747d5a7099e45f69dc1d099945909a9/update-role-permission

{
  "pipeline_id" : null,
  "operation_query" : true,
  "operation_execute" : true,
  "operation_update" : true,
  "operation_delete" : false,
  "operation_authorize" : false,
  "role_id" : 4
}

Example Responses

Status code: 200

Response body.

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.