Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition
Manage API Key userview element allows you to control access to API documents created with the API Builder.
Panel
borderColorpurple
borderWidth1
titleBGColor#ddccff
borderStylesolid
titleNew Feature

This is a new feature in Joget DX.

Image Added

Figure 1: Manage API Key in a userview


Image Added

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


Image Added

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.

Info
titleExample

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

IP Address Whitelist

IP address whitelist to allow API calls.

Info
titleExample

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

RemarkAny remark or description for the created API access.