1.1About this guide
Last updated
This guide describes SYNERGY Management Gateway for Active Directory version 0.177. It is written for two groups of readers:
- Administrators who install the product, connect it to Active Directory, decide who may do what, and keep the installation healthy.
- Operators and help desk staff who use the web console every day to look up, create and change directory objects.
Integrators who call the REST API, connect AI agents or build n8n workflows will find their own chapters later in the guide, but should read this introduction first: the concepts described here apply to every way of reaching the product.
How the guide is organised
| Chapter | Title | Main reader |
|---|---|---|
| 1 | Introduction | Everyone |
| 2 | Installation and first-time setup | Administrators |
| 3 | Signing in and your account | Everyone |
| 4 | Working in the console | Everyone |
| 5 | Directory connections | Administrators |
| 6 | Directory Browser | Operators |
| 7 | Deleted objects (Recycle Bin) | Operators |
| 8 | Saved LDAP filters | Operators |
| 9 | Operations log, approvals and waiting operations | Everyone |
| 10 | Operation policies, attribute policies and agent supervision | Administrators |
| 11 | Users, roles and permissions | Administrators |
| 12 | API keys | Administrators, integrators |
| 13 | AI agents (MCP server) | Administrators, integrators |
| 14 | n8n integration | Integrators |
| 15 | REST API for integrators | Integrators |
| 16 | Notifications | Administrators |
| 17 | Single sign-on | Administrators |
| 18 | Monitoring and logs | Administrators |
| 19 | Licence, updates and backups | Administrators |
Conventions used in this guide
| Convention | Meaning |
|---|---|
| Bold text | A label you see on screen: a menu item, button, field or tab, for example Save or Directory Browser. |
Monospace text | Something you type or read exactly: a path, a configuration key, a permission name, an error code or a URL, for example users:update or /backend/health/ready. |
| Italic text | A term being introduced for the first time, or a placeholder you replace with your own value. |
| "To do X:" followed by numbered steps | A procedure. Carry out the steps in order. |
https://gateway.example.com | An example address. Replace it with the address of your own installation. |
Callouts draw your attention to information that is easy to miss:
Note: Background information that explains why the product behaves as it does.
Important: Something that can cause an outage, a security exposure or data loss if ignored.
Tip: A shortcut or a better way to do something.
Permission names such as ad:users:read or operations:approve appear throughout the guide. They are listed in full in Chapter 11, Users, roles and permissions. Where a feature requires a licence module, the module key (for example directory-browser) is given; Chapter 19, Licence, updates and backups explains how modules are licensed.
Screenshots in this guide were taken with the English user interface. The console is also available in Lithuanian; labels in that language differ, but the layout is the same.
Last updated
Thank you for your feedback.