Querying Pipeline User Permissions

Function

This API is used to query pipeline user permissions.

Calling Method

For details, see Calling APIs.

URI

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
subject	No	String	Fuzzy search by user name.
limit	Yes	Long	Number of records on each page.
offset	Yes	Long	Offset.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
offset	Integer	Offset.
limit	Integer	Number of records on each page.
total	Integer	Total number.
users	Array of users objects	List of user permission details.

**Table 4** users
Parameter	Type	Description
pipeline_id	String	Pipeline ID.
role_id	Integer	Role ID.
role_name	String	Role name.
operation_query	Boolean	Permission to query.
operation_execute	Boolean	Permission to execute.
operation_update	Boolean	Permission to edit.
operation_delete	Boolean	Permission to delete.
operation_authorize	Boolean	Permission to configure pipeline permissions.
user_id	String	User ID.
user_name	String	Username.
domain_name	String	Tenant name.
nick_name	String	Nickname.
remark_name	String	Remarks.
tags	String	Tag.

Example Requests

GET https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-permissions/0747d5a7099e45f69dc1d099945909a9/user-permission?subject=&limit=10&offset=0

Example Responses

Status code: 200

Response body.

{
  "offset" : 0,
  "limit" : 10,
  "total" : 1,
  "users" : [ {
    "pipeline_id" : "0747d5a7099e45f69dc1d099945909a9",
    "role_id" : 1,
    "role_name" : "Pipeline creator",
    "operation_query" : true,
    "operation_execute" : true,
    "operation_update" : true,
    "operation_delete" : true,
    "operation_authorize" : false,
    "user_id" : "123456",
    "user_name" : "p_t123",
    "domain_name" : "1234546",
    "nick_name" : "n23456",
    "remark_name" : null,
    "tags" : null
  } ]
}