14.3Creating the credential in n8n
Last updated
The node uses a credential of type SYNERGY Management Gateway API.
To create the credential:
- In n8n, open Credentials (or add the node to a workflow and choose Create new credential from its credential field).
- Search for SYNERGY Management Gateway API and select it.
- Fill in the fields described in the table below.
- Select Save. n8n tests the credential automatically.
| Field | Required | What to enter |
|---|---|---|
| API URL | Yes | The base URL of the gateway's machine API, including /api, for example https://gateway.example.com/api. Must start with https://. |
| Client ID | Yes | The Client ID of the API key's binding. Selects the Active Directory the node works on. |
| API Key | Yes | The API key issued in the web console. Stored by n8n as a secret. |
| Ignore SSL Errors | No | Turns off certificate validation. Use only against a trusted test server. |
If the gateway is published under an application path, include it: for example https://gateway.example.com/backend/api. The most common mistake is to leave /api off the end of the URL. The node calls paths such as /ad/users and /saved-ldap-filters, which only reach the right place when the base URL ends in /api.
When you save, the credential test calls GET /metadata. That call needs only a valid API key and no particular permission, so a successful test proves the URL and the key are right. It does not prove that the Client ID is correct or that the role holds the permissions your workflow uses; the first real operation will tell you that.
The credential refuses an http:// URL, both in the test and when the node runs, so that the API key is never sent over an unencrypted connection.
Important: Ignore SSL Errors disables certificate checking and exposes the API key to anyone who can intercept the connection. Never turn it on for a production gateway. Install a certificate that the n8n host trusts instead.
When the credential does not work
| Symptom | Likely cause |
|---|---|
| "Insecure API URL" | The API URL does not start with https://. |
401 on the test | The API key is wrong, revoked or expired, or the n8n host's address is not in the key's Allowed addresses. |
404, or a web page instead of data, on every operation | /api (or the application path) is missing from the API URL. |
400 Invalid X-Client-Id | No directory link has that Client ID. Copy it again from the key's Directory section. |
403 "does not belong to the authenticated API key" | The Client ID belongs to a different API key's directory link. |
403 "no longer available to the key's owner" | The key's owner can no longer use the linked directory. |
403 "An active licence is required to perform Active Directory operations." | The installation has no active licence. |
403 on one operation only | The key's role lacks the permission for that operation. |
Last updated
Thank you for your feedback.