Identity Mesh Documentation
Everything you need to integrate, configure, and optimize Identity Mesh for your organization.
Documentation Sections
Getting Started
Quick start guide to set up Identity Mesh in minutes
- Installation
- First Sync
- Configuration
- Verify Results
API Reference
Complete REST API documentation with examples
- Authentication
- Endpoints
- Mesh Objects
- Rate Limits
Connector Configuration
Bidirectional Active Directory, SQL, and File connectors, Entra ID with group write-back, Workday with preferred name and work email write-back, plus import-only Okta
- Active Directory
- SQL Database
Projection Pipeline
Outbound provisioning, attribute mapping, and export queue
- Projection Rules
- Required Attributes
- Delta Computation
- Export Queue
MeshComposer
Dynamic group composition from mesh objects using rule-based criteria
- Create & Populate Modes
- Criteria Trees
- Preview & Evaluate
- Publish Targets
Policy Rules
Transform policy syntax and examples
- Syntax
- Functions
- Conditions
- Examples
Relay Agent
Outbound-only remote connectivity for identity systems behind firewalls
- Outbound-Only Connectivity
- Agent Deployment
- API Key Security
- SignalR Transport
Security & Compliance
Security best practices and compliance guides
- Encryption
- Access Control
- Audit Logs
- Compliance
Multi-Instance
Distribute connector workload across multiple sync engine instances
- Instance Registration
- Connector Assignment
- Per-Instance Pause
- Deployment Patterns
Operator Runbooks
Production install, upgrade, disaster recovery, audit, secrets, SIEM
- Backup & Restore (RPO/RTO)
- Secret Rotation
- Audit Retention
- SIEM Integration
Tutorials
Step-by-step guides for common scenarios
- M&A Integration
- SQL to Active Directory Sync
- Custom Attribute Transformations
- Audit Logging and Run History
Quick Links
Popular Guides
Operator Runbooks
- All runbooks
- AI Assistance
- Appearance & Branding
- Audit Retention
- Authentication (Negotiate + Entra ID)
- Backup & Restore (RPO/RTO)
- Custom Connectors
- Custom Workflow Steps
- Event Log
- Installer
- Isolate and Disconnect
- MeshComposer
- Mesh Workflows
- Projection Templates
- Reconciliation
- Secret Rotation
- Self-Service Groups
- SIEM Integration
- Vault Operations
- System Architecture
Need Help Getting Started?
Our team can help you with implementation, best practices, and custom integrations.