Reference

Look up config keys, filter syntax, error codes, telemetry signals, and data shapes. Reference pages generated from source stay in sync with your running version.

Section	What’s in it
Data Model	Entry identifiers, operational attributes, change events
Filters	FleX, JSON, SCIM, LDAP filter syntax
Config	All configuration keys (HOCON + env vars)
Telemetry	Metric names, attribute keys, span names
Error Codes	Error catalog with protocol mappings

Quick reference

Entry identifiers

Every entry supports four identifier formats. Use whichever your protocol needs.

Format	Example	When to use
GlobalId	`dXNlcjo5aXg`	Default. URL-safe, fastest lookup.
UUID	`550e8400-e29b-41d4-a716-446655440000`	External system integration
DN	`cn=john,ou=users,dc=example,dc=com`	LDAP compatibility
UOID	`12345`	Legacy numeric references

Filter syntax at a glance

The same query in each format:

FleX:   cn = John
JSON:   {"cn": "John"}
SCIM:   cn eq "John"
LDAP:   (cn=John)

Scribe auto-detects the format. See Filters for operators, combinators, and attribute groups.

Key environment variables

Variable	Purpose
`SCRIBE_LDAP_URL`	Source LDAP server URL
`SCRIBE_DATABASE_URL`	PostgreSQL connection string
`SCRIBE_AUTH_ENABLED`	Enable authentication (`true`/`false`)
`SCRIBE_AUTH_ISSUER`	OAuth2/OIDC issuer URL

All SCRIBE_* variables map to config keys. See Configuration for the full mapping, or Config Reference for every key.

Deep links

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 work with both OTel (dotted) and Prometheus (underscore) notation.