¶ 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

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

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.dto.CreatePipelineFunctionDto;
import cn.authing.sdk.java.dto.PipelineFunctionSingleRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class CreatePipelineFunctionTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        CreatePipelineFunctionDto createPipelineFunctionDto = new CreatePipelineFunctionDto();
        createPipelineFunctionDto.setSourceCode("SOURCE_CODE");
        PipelineFunctionSingleRespDto pipelineFunction = client.createPipelineFunction(createPipelineFunctionDto);
        System.out.println(JsonUtils.serialize(pipelineFunction));
    }
}

¶ Request Response

Type： PipelineFunctionSingleRespDto

Example Results：

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