Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Permissions of a Project
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Permissions of a Project

Function

This API is used to query permissions of a project.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/check-project/{type}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

type

Yes

String

Definition:

Permission type.

Constraints:

N/A

Value range:

  • create: Create a pipeline.

  • ban: Disable a pipeline.

  • group: Group pipelines.

  • read: Check a pipeline.

  • tag: Tag a pipeline.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

[items]

Array of PermissionResult objects

Definition:

Permission details.

Value range:

N/A
Table 3 PermissionResult

Parameter

Type

Description

key

String

Definition:

Permission type.

Value range:

  • create: Create a pipeline.

  • ban: Disable a pipeline.

  • group: Group pipelines.

  • read: Check a pipeline.

  • tag: Tag a pipeline.

value

Boolean

Definition:

Whether the account has the permission.

Value range:

  • true: The account has the permission.

  • false: The account does not have the permission.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Pipeline Management