- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
管理 Pipeline
- /
- 获取 Pipeline 函数详情
¶ Get Pipeline function details
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.
Get Pipeline function details
¶ Method name
ManagementClient.get_pipeline_function
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| funcId | string | Yes | - | Pipeline function ID | 62ce9135dxxxxb83e373f5d6 |
¶ Request response
Type: PipelineFunctionSingleRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (successful requests are not returned). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | PipelineFunctionDto | Response data |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"funcId": "62ce9135dxxxxb83e373f5d6",
"funcName": "Registration/login is prohibited from 3-6 am every Sunday for system maintenance",
"funcDescription": "Registration/login is prohibited from 3-6 am every Sunday for system maintenance.",
"scene": "PRE_REGISTER",
"createdAt": "2022-07-03T03:20:30.000Z",
"updatedAt": "2022-07-03T03:20:30.000Z",
"timeout": 3,
"sourceCode": "async function pipe(user, context, callback) {\n const date = new Date();\n const d = date.getDay();\n const n = date.getHours();\n // Registration is prohibited from 3-6 am every Sunday\n if (d === 0 && (3 <= n && n <= 6)) {\n return callback(new Error('System maintenance, registration is temporarily suspended!'));\n }\n callback(null, user, context)\n}",
"status": "success"
}
}
¶ Data structure
¶ PipelineFunctionDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| funcId | string | Yes | Function ID | 62ce9135dxxxxb83e373f5d6 |
| funcName | string | Yes | Function name | Registration/login is prohibited from 3-6 a.m. every Sunday due to system maintenance |
| funcDescription | string | No | Function description | Registration/login is prohibited from 3-6 a.m. every Sunday due to system maintenance. |
| scene | string | yes | Function triggering scenario: - PRE_REGISTER: before registration- POST_REGISTER: after registration- PRE_AUTHENTICATION: before authentication- POST_AUTHENTICATION: after authentication- PRE_OIDC_ID_TOKEN_ISSUED: before OIDC ID Token issuance- PRE_OIDC_ACCESS_TOKEN_ISSUED: before OIDC Access Token issuance- PRE_COMPLETE_USER_INFO: before completing user information | PRE_REGISTER |
| createdAt | string | yes | Function creation time | 2022-07-03T03:20:30.000Z |
| updatedAt | string | yes | Function modification time | 2022-07-03T03:20:30.000Z |
| isAsynchronous | boolean | yes | Whether to execute asynchronously. Functions set to asynchronous execution will not block the execution of the entire process, and are suitable for asynchronous notification scenarios, such as Feishu group notifications, DingTalk group notifications, etc. | |
| timeout | number | yes | Function execution timeout, the shortest is 1 second, the longest is 60 seconds, and the default is 3 seconds. | 3 |
| terminateOnTimeout | boolean | yes | If the function runs out of time, whether to terminate the entire process, the default is no. | |
| sourceCode | string | yes | function source code | `async function pipe(user, context, callback) { |
const date = new Date(); const d = date.getDay(); const n = date.getHours(); // Registration is prohibited from 3-6 am every Sunday if (d === 0 && (3 <= n && n <= 6)) { return callback(new Error('System maintenance, registration temporarily suspended!')); } callback(null, user, context) }| | status | string | yes | Function current status: <br>-uploading: Uploading<br>-success: Upload successful<br>-failed`: Upload failed
| uploading | | uploadErrMsg | string | no | Error message for upload failure | | | enabled | boolean | yes | Is this Pipeline enabled | |