Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

Usages

  • API Authenticator Plugin is used as an extension or replacement for the default authentication methods available in the API Builder.
  • This plugin type must extend org.joget.api.model.ApiAuthenticatorAbstract abstract class.

POM file adjustments

  • Add the project dependencies below:

    <!-- Add this dependency for authenticate(...) params -->
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>jsp-api</artifactId>
        <version>2.0</version>
    </dependency>
    
    <!-- Add apibuilder_api dependency -->
    <dependency>
        <groupId>org.joget.api</groupId>
        <artifactId>apibuilder_api</artifactId>
        <version>${project.version}</version>
        <scope>provided</scope>
    </dependency>

Abstract Class

org.joget.api.model.ApiAuthenticatorAbstract

Abstract Methods

authenticate
public boolean authenticate(HttpServletRequest request, HttpServletResponse response);

Used to authenticate API calls on an existing API document.

Parameters:

request - the http request information

response - the http response to write

Plugin Properties Options

Sample Plugins



  • No labels