Help Center/ CodeArts Build/ API Reference/ APIs/ PermissionManager/ Updating the Permissions Assigned to a Specific Role for a Build Task
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating the Permissions Assigned to a Specific Role for a Build Task

Function

This API is used to update the permissions assigned to a specific role for a build task.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/job/role-permission

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

job_id

No

String

Definition

Build task ID.

It includes digits and letters. To obtain this ID, open the page for editing the build task in your browser, and copy the 32-character string at the end of the URL.

Constraints

N/A.

Range

The 32-character string sits at the end of the URL and includes digits and letters.

Default Value

N/A.

role_id

No

String

Definition

Role ID.

Constraints

N/A.

Range

N/A.

Default Value

N/A.

permission_name

No

String

Definition

Permission name.

Constraints

N/A.

Range

is_modify, is_delete, is_view, is_execute, is_copy, is_forbidden, or is_manager.

Default Value

N/A.

permission_value

No

Boolean

Definition

Whether to modify the permission.

Constraints

N/A.

Range

true or false

Default Value

true.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition

API response status.

Range

● success: The API call is successful.

● fail: The API call failed.

error

Object

Definition

Error message.

Range

N/A.

result

String

Definition

Data returned after the API is successfully called.

Range

N/A.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

PUT https://{endpoint}/v1/job/role-permission/update

Example Responses

Status code: 200

OK

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: PermissionManager