Data model
- Identify
Find stable entry identifiers.
- Read
Inspect values and operational attributes.
- Revisit
Read change events and past states.
Look up the fields and identifiers used by API responses.
Next: API formats
Scribe stores identity data as entries. See Architecture for how they fit into the sync and query pipeline.
Entry identifiers
Section titled “Entry identifiers”Every entry can be referenced by four formats. All channels accept all formats.
| Format | Example | When to use |
|---|---|---|
| GlobalId | dXNlcjo5aXg | Fastest lookup — use the id from query results |
| UUID | 550e8400-e29b-41d4-a716-446655440000 | External system integration |
| UOID | 12345 | Legacy numeric references |
| DN | cn=john,ou=users,dc=example,dc=com | LDAP compatibility |
GlobalId is the recommended default. It’s URL-safe (no escaping needed), stable (assigned once, never changes), and fast (the entry type is encoded in the ID, so lookups skip type resolution). The canonical attribute name is entryID, with id as a convenience alias. Treat it as an opaque string.
Attributes
Section titled “Attributes”User data is synced from the source directory; the two other categories are described below.
Operational attributes
Section titled “Operational attributes”Every entry carries metadata alongside user-defined data. Request them with the + directive (REST: ?fields=+, LDAP: add + to the attribute list) or by name.
| Canonical | Aliases | Purpose |
|---|---|---|
entryID | id | URL-safe global identifier |
entryUOID | uoid | Internal numeric database row ID |
entryDN | dn, distinguishedName | Distinguished Name (full LDAP path) |
entryUUID | uuid, objectGUID, nsuniqueid, guid, ibm-entryuuid, dominoUNID | RFC 4122 UUID with product-specific aliases |
entryType | type | Entry type name (User, Group, etc.) |
entryRDN | rdn, relativeDN | Path relative to the entry type’s base DN |
entryName | — | First RDN value (the “simple name”) |
eTag | etag, entryCSN, revision | Change tracking token |
createTimestamp | createdAt, whenCreated | Creation time |
modifyTimestamp | updatedAt, whenChanged | Last modification time |
verifiedTimestamp | verifiedAt, lastVerifiedAt | Last verification against source |
Responses always use canonical names, even when you request an alias. Both forms work in filters and projections.
Entry naming
Section titled “Entry naming”Two attributes give shorter alternatives to the full DN:
entryName— the name portion. Forcn=John Doe,ou=users,dc=example,dc=com, entryName isJohn Doe. Indexed for fast lookups.entryRDN— the path relative to the type’s configured base. For the same entry under baseou=users,dc=example,dc=com, entryRDN iscn=John Doe.
Both support case-insensitive filtering, sorting, and projection across all channels.
Virtual attributes
Section titled “Virtual attributes”Some attributes are computed at query time rather than stored. The classic example is memberOf, which can expose a user’s groups from stored relationship data.
Define them under ldap.virtual-attributes to offer them on every entry type, or in a transcribe’s ldap section, where they always apply to that transcribe’s entry type. See Attribute Modeling for when to store a plain attribute instead, and Transcribes configuration for the full syntax.
Entry types
Section titled “Entry types”An entry type groups directory entries of the same kind — users, groups, devices. Each type maps to a transcribe that defines what to sync (base DN, filter, scope, attributes, indexes).
See Architecture > Transcribes for how entry types work in the sync pipeline.
Change events
Section titled “Change events”Every change Scribe detects updates the current entry and appends an event to its history:
| Type | Carries |
|---|---|
| add | Full attribute set of the new entry |
| modify | Diff — which attribute changed, how, and to what value |
| move | Old and new DN |
| delete | Entry identifier |
Synchronization only ever appends events; each has a unique position and a timestamp. The history makes point-in-time queries and full audit history possible. The one exception is an upgrade that repairs a history known to be wrong, such as removing a false add event; the release notes name each such repair.
See Architecture > Events for how change detection works.
Change data formats
Section titled “Change data formats”MODIFY events provide three representations of the change. All use delta semantics (what changed, not the full state):
| Format | Description | When to use |
|---|---|---|
diff | Attribute-level operations: SET, ADD, REMOVE | Internal processing, full detail |
patch | JSON Patch style with /attribute/- for array additions | JSON Patch-compatible consumers |
merge | JSON Merge Patch style with changed values only | Simple consumers that just want the new values |
data { ... on ModifyData { diff { attribute operation value } patch { operation path value } merge { attribute values } }}All three formats are available in the GraphQL and REST channels.
Temporal references
Section titled “Temporal references”Time-based parameters (at, since, until, range) accept flexible formats: ISO timestamps, durations, relative expressions (now-1h), and natural language (yesterday, last 3 days). See Filters > Temporal references for the complete format table.