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
| Name | Description |
|---|---|
API Key | A unique identifier used to authenticate to an API document. |
| Authentication Method | Methods available:
|
| API Secret (API Key & Token method) | A secret string used for authentication. |
| Token Pattern (API Key & Token method) | Token Pattern consists of hash algorithm (MD5, SHA-1, SHA-256 and SHA-512) and variables ({api_key}, {api_secret}, {date_pattern}). Example: SHA-256({api_key}::{api_secret}::{yyyy-MM-dd HH:mm}) |
| Permission Plugin (Basic access authentication method) | Select a permission plugin and configure its properties. Find list of available permission plugins here. |
| Custom Authenticator Plugin | Select a custom authenticator plugin and configure its properties. This option is shown only if a plugin of that type exist in the system. Learn more about Custom Authenticator plugin here. |
| Custom Authentication Method | Methods available:
Note: API Key is always required regardless of method selected above. |
| Domain Whitelist | Domain whitelist to allow API calls. Example "localhost;www.joget.org;dev.joget.org”, or "*" to allow from everywhere. |
| IP Address Whitelist | IP address whitelist to allow API calls. Example "127.0.0.1;192.168.0.1”, or "*" to allow from everywhere. |
| Remark | Any remark or description for the created API access. |
Figure 4: Manage API Key properties