FAQ
- Getting started
What Scribe does and which APIs are available.
- Access problems
Why an API is hidden or a request fails.
- Investigation
How to obtain more diagnostic information.
Find a direct answer below, then follow its guide when you need the full procedure.
Next: Troubleshooting
Quick answers. For full details, follow the links.
What is IdentityScribe?
Section titled “What is IdentityScribe?”Scribe syncs LDAP directories to PostgreSQL and serves queries through LDAP, REST, GraphQL, and MCP channels. Every change is appended to the entry history. See Architecture.
What protocols are available?
Section titled “What protocols are available?”LDAP, REST, and GraphQL are stable. MCP is experimental and gRPC is on the roadmap. See Channels for details and examples.
Why does /api return 404?
Section titled “Why does /api return 404?”By default IdentityScribe runs in production mode, which hides the interactive API documentation at /api. Your data routes under /api/entries/... and the Operator UI keep working. See API Access & Networking — Production API documentation.
How do I enable the REST API?
Section titled “How do I enable the REST API?”The REST channel is off by default. Set channels.rest.enabled = true (or SCRIBE_REST_ENABLED=true) and restart. See API Access & Networking — Enable REST data routes.
How do I check if sync is working?
Section titled “How do I check if sync is working?”Check the ingest stats at /observe/stats/ingest. See Monitoring.
How do I add another entry type?
Section titled “How do I add another entry type?”Add a new block under transcribes {} in your config file. Each transcribe syncs one entry type. See Transcribes configuration.
How do I rotate credentials?
Section titled “How do I rotate credentials?”Update the environment variables (LDAP_BIND_PASSWORD, DB_PASSWORD, etc.) and restart. Scribe reads secrets from env vars at startup. See Production Checklist.
What happens during an upgrade?
Section titled “What happens during an upgrade?”Scribe runs database migrations automatically on startup. See Upgrading for version-specific migration notes and breaking changes.
How do I debug a problem?
Section titled “How do I debug a problem?”Enable debug logging with SCRIBE_LOG_LEVEL=debug, check the doctor endpoint at /observe/doctor, or inspect traces. See Logging and Traces for the full investigation workflow.