Identity Mesh Logo Identity Mesh
Documentation / Getting Started

Get Started with Identity Mesh

On-premises installation guide. Install the sync engine, connect your identity systems, and run your first import.

Prerequisites

Before you begin, ensure you have:

  • Windows Server 2019 or later for hosting the sync engine service
  • SQL Server 2019 or later for the Identity Mesh database
  • .NET 8 Runtime installed on the server
  • Active Directory domain (if using the AD connector)

Installation & Setup

1

Install the Windows Service

The Identity Mesh sync engine runs as a Windows Service. Install it using the MSI installer.

MSI Installation
  1. 1. Run the IdentityMesh.msi installer on your Windows Server
  2. 2. Follow the installation wizard to choose the install directory
  3. 3. Specify the service account the Windows Service will run under
  4. 4. The installer registers the Identity Mesh Sync Engine as a Windows Service
2

Configure Database Connection

Point the service to your SQL Server instance. The database schema is created automatically on first run.

Configuration
  1. 1. Open appsettings.json in the Identity Mesh installation directory
  2. 2. Set the ConnectionStrings:IdentityMesh value to your SQL Server connection string
  3. 3. Ensure the service account has db_owner rights on the target database
  4. 4. Start the service — all required tables and schemas are created on first startup
3

Add Your First Connector

Use the Admin UI to configure an Active Directory or SQL Database connector with connection details.

Example: Active Directory Connector
  1. 1. Open the Admin UI and navigate to Connectors → Add Connector
  2. 2. Select Active Directory or SQL Database as the connector type
  3. 3. Enter the server hostname, port, and base DN (for AD) or connection string (for SQL)
  4. 4. Provide service account credentials with read access to the target directory or database
  5. 5. Test the connection and save
View connector configuration guide
4

Create Join and Flow Rules

Define how identities are correlated across systems and how attributes flow between them.

  1. 1. Navigate to Rules in the Admin UI
  2. 2. Create a join rule to define anchor-based identity correlation (e.g., match AD objectGUID to an HR database EmployeeID)
  3. 3. Create flow rules to map attributes between connectors (e.g., AD displayName → mesh FullName)
  4. 4. Apply transforms where needed (concatenation, formatting, case conversion)
  5. 5. Set confidence scores on flow rules to control which source wins when multiple connectors provide the same attribute
Learn about join and flow rules
5

Run Your First Import

Trigger a full import from the Admin UI to pull identities into the mesh.

  1. 1. Go to Connectors and select the connector you configured
  2. 2. Click Full Import to read all objects from the connected system
  3. 3. Monitor progress in the import run log as identities are pulled into the management space
  4. 4. Once import completes, the projection engine applies your join and flow rules to populate mesh objects
6

Verify in Mesh Objects

Browse imported identities in the Mesh Objects viewer in the Admin UI.

  • Open Mesh Objects in the Admin UI to see correlated identities
  • Verify that attributes flowed correctly from the source connector
  • Check join status to confirm identities are linked across connectors
  • Review the audit log for any import errors or rule evaluation warnings

Next Steps

Connector Configuration

Set up Active Directory, SQL, and other connectors in detail

Policy & Rules

Advanced join rules, flow rules, transforms, and confidence scoring

Projection Pipeline

Understand the import, projection, and export pipeline end-to-end

Need Help?

Our team is here to help you get installed and answer any questions.

Contact Support