Manage API Key userview element allows you to control access to API documents created with the API Builder.

This is a new feature in Joget DX.

Figure 1: Manage API Key in a userview


Figure 2: Manage API Key in a userview - Log view


Figure 3: Manage API Key in a userview - New/Edit access

NameDescription

API Key

A unique identifier used to authenticate to an API document.
Authentication MethodMethods available:
  • API Key
  • API Key & Token
  • Basic access authentication
Custom Authenticator Plugin

Select a custom authenticator plugin.

This option is shown only if a plugin of that type exist in the system.

Learn more about Custom Authenticator plugin here.

Domain Whitelist

Domain whitelist to allow API calls.

"localhost;www.joget.org;dev.joget.org”, or "*" to allow from everywhere.

IP Address Whitelist

IP address whitelist to allow API calls.

"127.0.0.1;192.168.0.1”, or "*" to allow from everywhere.

RemarkAny remark or description for the created API access.