Choose an API
- LDAP
Connect existing directory applications.
- REST or GraphQL
Query entries from an HTTP application.
- MCP
Connect an assistant; this API is experimental.
You can choose an API without changing the directory data you synchronize.
You decide: Use LDAP for existing LDAP clients, REST for HTTP/JSON, or GraphQL to select fields.
Scribe speaks your protocol. Pick a channel — LDAP, REST, GraphQL, or MCP — and start querying. All channels share the same query engine, so results are identical regardless of which one you use.
Pick a channel
Section titled “Pick a channel”| Channel | What it’s for | Status |
|---|---|---|
| LDAP | Existing LDAP apps — no code changes needed | Stable |
| REST | HTTP/JSON for microservices and automation | Stable |
| GraphQL | Flexible queries for frontends | Stable |
| MCP | AI coding assistants (Cursor, Claude, VS Code) | Experimental |
| gRPC | Service mesh and high-throughput pipelines | Roadmap |
Shared query engine
Section titled “Shared query engine”An LDAP search and a GraphQL query for the same data return the same entries. Architecture shows the stages every query passes through.
What’s shared across channels
Section titled “What’s shared across channels”Authentication. All channels support bearer token authentication. LDAP also supports bind-based authentication with username/password, configured local accounts, or proxy authorization.
Authorization. One set of access rules applies to every channel. A rule can match a single channel with request.channel.
Pagination. Each channel uses pagination native to its protocol:
| Channel | Style | Parameters |
|---|---|---|
| LDAP | Simple Paged Results, VLV | LDAP controls |
| REST | Cursor pagination | first/after, last/before, limit |
| GraphQL | Cursor pagination (Relay) | first/after, last/before |
| MCP | Cursor pagination | limit/cursor; change tools also take before |
Entry identifiers. Every entry can be looked up by GlobalId, UUID, UOID, or DN. All channels accept all formats. See Data Model for details.
Operational attributes. Metadata like entryID, entryUUID, timestamps, and ETags are available on every entry. See Data Model for the full list.
Filters. Queries accept FleX, JSON, SCIM, or LDAP filter syntax. Scribe auto-detects the format.
Temporal references. Time-based parameters support ISO timestamps, durations, relative expressions (now-1h), and natural language (yesterday, last 3 days). See Filters reference.
Errors. All channels share the unified failure model. Errors map to protocol-appropriate responses. See Error Handling.
API discovery
Section titled “API discovery”The /.well-known/api-catalog endpoint provides machine-readable API discovery per RFC 9727. Clients can discover all enabled channels, their base paths, and schema URLs from a single request.
Get channel runtime status (bound ports, enabled channels) at /observe/channels. See Endpoints Reference for response details.
For configuration options, see Configuration Reference.