14n8n integration

n8n is a workflow automation tool. SYNERGY Management Gateway publishes a community node for it, so that an n8n workflow can create, change, read and delete Active Directory objects through the gateway instead of talking to a domain controller directly. A joiners-and-leavers process, a nightly clean-up of stale computer accounts, or a ticket that adds a person to a group can all be built as n8n workflows.

Because every request from the node goes through the gateway, everything that applies to any other caller applies to the node too: the permissions of the API key's role, the directory the key is bound to, operation policies, agent supervision and approval, the operations log and notifications. The node adds no shortcut around any of them.

This chapter explains how to install the node, how to create its credential, what each resource and operation does, and how to build workflows that cope with changes that must wait for a person's approval.

How the node connects

The node is an ordinary client of the gateway's machine API (the /api surface, described in Chapter 15, REST API for integrators). Every request it sends carries two headers taken from its credential:

• X-API-Key — the API key that authenticates the request. The key acts as the person who owns it, limited to the permissions of the role the key was given.
• X-Client-Id — the client ID of the key's binding to an Active Directory connection. This decides which directory the operation runs against.

The node refuses to send the key over plain HTTP: the API URL must start with https://.

Before you start, you need:

• A self-hosted n8n instance that can reach the gateway over HTTPS. The node is a community node and is not offered on n8n Cloud as a verified node.
• An API key issued in SYNERGY Management Gateway, with a role that holds the permissions your workflows need (see Chapter 12, API keys).
• A binding from that API key to the Active Directory connection the workflows should manage, with its Client ID.
• An active licence. An unlicensed installation refuses every directory operation with 403 License.NotActivated (see Chapter 19, Licence, updates and backups).