¶ Create Pipeline function

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 the V3 API.

Create Pipeline function

¶ Method name

ManagementClient.create_pipeline_function

¶ Request parameters

const date = new Date(); const d = date.getDay(); const n = date.getHours(); // Disable registration from 3-6 a.m. every Sunday if (d === 0 && (3 <= n && n <= 6)) { return callback(new Error('System maintenance, registration is temporarily suspended!')); } callback(null, user, context) }| | scene | string | yes | - | Function triggering scenario:<br>-PRE_REGISTER: before registration<br>-POST_REGISTER: after registration<br>-PRE_AUTHENTICATION: before authentication<br>-POST_AUTHENTICATION: after authentication<br>-PRE_OIDC_ID_TOKEN_ISSUED: before OIDC ID Token issuance<br>-PRE_OIDC_ACCESS_TOKEN_ISSUED: before OIDC Access Token issuance<br>-PRE_COMPLETE_USER_INFO: before completing user information<br> |PRE_REGISTER| | funcName | string | yes | - | Function name |Every Sunday morning 3-6 System maintenance prohibits registration/login| | funcDescription | string | No | - | Function description |Registration/login is prohibited every Sunday morning from 3 to 6 a.m. for system maintenance. | | isAsynchronous | boolean | No | - | 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 | No | 3 | Function execution timeout, which must be an integer, with a minimum of 1 second and a maximum of 60 seconds. The default is 3 seconds. |3` | | terminateOnTimeout | boolean | No | - | If the function runs out of time, whether to terminate the entire process. The default is no. | | | enabled | boolean | no | - | Whether to enable this Pipeline | |

¶ Request response

Type: PipelineFunctionSingleRespDto

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

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