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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
subject	No	String	Definition: Fuzzy search by username. Constraints: N/A Value range: N/A Default value: N/A
limit	Yes	Long	Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A
offset	Yes	Long	Definition: Offset where the query starts. Constraints: N/A Value range: The value is no less than 0. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
offset	Integer	Definition: Offset where the query starts. Value range: The offset value must be no less than 0.
limit	Integer	Definition: Number of records of each query. Value range: The value is no less than 0.
total	Integer	Definition: Total number of queried records. Value range: N/A
users	Array of users objects	Definition: User permissions. Value range: N/A

**Table 4** users
Parameter	Type	Description
pipeline_id	String	Definition: Pipeline ID. Value range: N/A
role_id	Integer	Definition: Role ID. Value range: N/A
role_name	String	Definition: Role name. Value range: N/A
operation_query	Boolean	Definition: Query permission. Value range: N/A
operation_execute	Boolean	Definition: Execution permission. Value range: N/A
operation_update	Boolean	Definition: Edit permission. Value range: N/A
operation_delete	Boolean	Definition: Delete permission. Value range: N/A
operation_authorize	Boolean	Definition: Permission to edit the pipeline permission configurations. Value range: N/A
user_id	String	Definition: User ID. Value range: N/A
user_name	String	Definition: Username. Value range: N/A
domain_name	String	Definition: Tenant name. Value range: N/A
nick_name	String	Definition: Nickname. Value range: N/A
remark_name	String	Definition: Remarks. Value range: N/A
tags	String	Definition: Label. Value range: N/A

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
  } ]
}