Reference
Technical reference for configuration, telemetry, error codes, and query filters.
Reference pages are generated from the shipped configuration and telemetry definitions, so they stay aligned with the running version. For practical examples, start with the Configuration guide.
Configuration reference
Section titled “Configuration reference”Detailed documentation for all configuration options organized by section:
- Config Overview - All configuration keys
- Per-section pages (database, ldap, monitoring, etc.)
See Configuration Guide for practical examples.
Telemetry reference
Section titled “Telemetry reference”Metrics, attributes, and span names exported by IdentityScribe:
- Metrics - All metric names (OTel + Prometheus)
- Attributes - All attribute keys
See Observability for operational guidance.
Error reference
Section titled “Error reference”Stable error codes and their meanings:
- Error Catalog - All error codes with troubleshooting hints
See Failures for troubleshooting guidance.
Filter reference
Section titled “Filter reference”Query filter syntax for REST and LDAP channels:
- Filters - LDAP, FleX, JSON, and SCIM filter formats
Deep links
Section titled “Deep links”All reference entries support canonical deep links via /ref/*:
| Kind | Route | Example |
|---|---|---|
| Config | /ref/c/<key> | /ref/c/database.max-pool-size |
| Metric | /ref/m/<name> | /ref/m/scribe.channel.requests.total |
| Attribute | /ref/a/<key> | /ref/a/scribe.query.signature |
| Error | /ref/e/<code> | /ref/e/DIRECTORY_BUSY |
| Shorthand | /ref/<token> | /ref/DIRECTORY_BUSY |
Metric names support both OTel (dotted) and Prometheus (underscore) notation.