Skip to content

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.

Choose the API that fits the client you already have.

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.

Next: Compare APIs and follow your setup link

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.

ChannelWhat it’s forStatus
LDAPExisting LDAP apps — no code changes neededStable
RESTHTTP/JSON for microservices and automationStable
GraphQLFlexible queries for frontendsStable
MCPAI coding assistants (Cursor, Claude, VS Code)Experimental
gRPCService mesh and high-throughput pipelinesRoadmap
Your clientLDAPstableRESTstableGraphQLstableMCPexperimentalexisting LDAP appHTTP automationpicks its fieldsAI assistant
Your clientLDAPstableRESTstableGraphQLstableMCPexperimentalexisting LDAP appHTTP automationpicks its fieldsAI assistant
Choose among the available channels by the client you need to connect.
CHANNELS · OWN FORMATLDAPLDAP resultsRESTJSONGraphQLselected fieldsMCPtool resultsQuery enginesharedStored entriessame queryreadssame entries
CHANNELS · OWN FORMATLDAPLDAP resultsRESTJSONGraphQLselected fieldsMCPtool resultsQuery enginesharedStored entriessame queryreadssame entries
Equivalent locally served queries share one query engine; each channel only formats its own response.

An LDAP search and a GraphQL query for the same data return the same entries. Architecture shows the stages every query passes through.

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:

ChannelStyleParameters
LDAPSimple Paged Results, VLVLDAP controls
RESTCursor paginationfirst/after, last/before, limit
GraphQLCursor pagination (Relay)first/after, last/before
MCPCursor paginationlimit/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.

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.