Querying Pipeline Role Permissions

Function

This API is used to query pipeline role permissions.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipeline-permissions/{pipeline_id}/role-permission

**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
pipeline_id	Yes	String	Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
roles	Array of roles objects	Definition: Details. Value range: N/A

**Table 3** roles
Parameter	Type	Description
pipeline_id	String	Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters.
role_id	Integer	Definition: Role ID. Value range: N/A
role_name	String	Definition: Role name. Value range: N/A
operation_query	Boolean	Definition: Whether the query permission is granted. Value range: true: The query permission is granted. false: The query permission is not granted.
operation_execute	Boolean	Definition: Whether the execution permission is granted. Value range: true: The execution permission is granted. false: The execution permission is not granted.
operation_update	Boolean	Definition: Whether the edit permission is granted. Value range: true: The edit permission is granted. false: The edit permission is not granted.
operation_delete	Boolean	Definition: Whether the delete permission is granted. Value range: true: The delete permission is granted. false: The delete permission is not granted.
operation_authorize	Boolean	Definition: Whether the permission to edit pipeline permission configurations is granted. Value range: true: The permission to edit pipeline permission configurations is granted. false: The permission to edit pipeline permission configurations is not granted.

Example Requests

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

Example Responses

Status code: 200

{
  "roles" : [ {
    "pipeline_id" : null,
    "role_id" : 1,
    "role_name" : "Pipeline creator.",
    "operation_query" : true,
    "operation_execute" : true,
    "operation_update" : true,
    "operation_delete" : true,
    "operation_authorize" : false
  } ]
}