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

Request parameters

Name	Type	Required	Default value	Description	Sample value
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 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 |Registration/login is prohibited during system maintenance from 3 to 6 a.m. every Sunday| | funcDescription | string | No | - | Function description |Registration/login is prohibited during system maintenance from 3 to 6 a.m. every Sunday.| | isAsynchronous | boolean | No | - | Whether to execute asynchronously. Functions set to execute asynchronously will not block the execution of the entire process and are suitable for asynchronous notification scenarios, such as Feishu group notifications and DingTalk group notifications. | | | 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 | - | Whether to terminate the entire process if the function times out. The default is No. | | | enabled | boolean | no | - | Whether to enable this Pipeline | |

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.createPipelineFunction({
    funcName: "Registration/login is prohibited every Sunday from 3 to 6 a.m.",
    funcDescription:
      "Registration/login is prohibited every Sunday from 3 to 6 a.m. System maintenance prohibits registration/login. ",
    scene: Models.CreatePipelineFunctionDto.scene.PRE_REGISTER,
    sourceCode: `async function pipe(user, context, callback) {
const date = new Date();
const d = date.getDay();
const n = date.getHours();
// Prohibit registration from 3-6 am every Sunday
if (d === 0 && (3 <= n && n <= 6)) {
return callback(new Error('System maintenance, temporarily stop registration!'));
}
callback(null, user, context)
}`,
    isAsynchronous: false,
    timeout: 3,
    terminateOnTimeout: false,
    enabled: false,
  });

  console.log(JSON.stringify(result, null, 2));
})();

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 request does not return). For a detailed list of error codes, please see: API Code List
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, temporarily stop registration!'));\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 during system maintenance from 3 to 6 a.m. every Sunday
funcDescription	string	No	Function description	Registration/login is prohibited during system maintenance from 3 to 6 a.m. every Sunday.
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 running 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, temporarily stop registration!')); } 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 | |