Skip to content

Data model

  • Identify

    Find stable entry identifiers.

  • Read

    Inspect values and operational attributes.

  • Revisit

    Read change events and past states.

Entries provide current values, identifiers and a history of changes.

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.

IDENTIFIERS · ONE ENTRYATTRIBUTESTranscribeconfigurationEntry typeUser, Group, …GlobalIddefaultUUIDRFC 4122UOIDnumericDNLDAP pathEntryUser datafrom LDAPOperationalset by ScribeVirtualat query timeChange historyappend-onlydefinesgroupsidentifyexposesrecords
IDENTIFIERS · ONE ENTRYATTRIBUTESTranscribeconfigurationEntry typeUser, Group, …GlobalIddefaultUUIDRFC 4122UOIDnumericDNLDAP pathEntryUser datafrom LDAPOperationalset by ScribeVirtualat query timeChange historyappend-onlydefinesgroupsidentifyexposesrecords
Four identifier formats refer to one entry, whose attributes and change history have different roles.

Every entry can be referenced by four formats. All channels accept all formats.

FormatExampleWhen to use
GlobalIddXNlcjo5aXgFastest lookup — use the id from query results
UUID550e8400-e29b-41d4-a716-446655440000External system integration
UOID12345Legacy numeric references
DNcn=john,ou=users,dc=example,dc=comLDAP 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.

User data is synced from the source directory; the two other categories are described below.

Every entry carries metadata alongside user-defined data. Request them with the + directive (REST: ?fields=+, LDAP: add + to the attribute list) or by name.

CanonicalAliasesPurpose
entryIDidURL-safe global identifier
entryUOIDuoidInternal numeric database row ID
entryDNdn, distinguishedNameDistinguished Name (full LDAP path)
entryUUIDuuid, objectGUID, nsuniqueid, guid, ibm-entryuuid, dominoUNIDRFC 4122 UUID with product-specific aliases
entryTypetypeEntry type name (User, Group, etc.)
entryRDNrdn, relativeDNPath relative to the entry type’s base DN
entryName—First RDN value (the “simple name”)
eTagetag, entryCSN, revisionChange tracking token
createTimestampcreatedAt, whenCreatedCreation time
modifyTimestampupdatedAt, whenChangedLast modification time
verifiedTimestampverifiedAt, lastVerifiedAtLast verification against source

Responses always use canonical names, even when you request an alias. Both forms work in filters and projections.

Two attributes give shorter alternatives to the full DN:

  • entryName — the name portion. For cn=John Doe,ou=users,dc=example,dc=com, entryName is John Doe. Indexed for fast lookups.
  • entryRDN — the path relative to the type’s configured base. For the same entry under base ou=users,dc=example,dc=com, entryRDN is cn=John Doe.

Both support case-insensitive filtering, sorting, and projection across all channels.

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.

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.

Every change Scribe detects updates the current entry and appends an event to its history:

EVENT · ONE OFLDAP changeAddall attributesModifyattribute diffMoveold + new DNDeleteentry IDChange historyappend-onlyCurrent entrylatest statePast viewany timebecomesappendsreconstructsupdates
EVENT · ONE OFLDAP changeAddall attributesModifyattribute diffMoveold + new DNDeleteentry IDChange historyappend-onlyCurrent entrylatest statePast viewany timebecomesappendsreconstructsupdates
Each detected change updates the current entry and appends an event; a past view is rebuilt from the events up to the time you ask for.
TypeCarries
addFull attribute set of the new entry
modifyDiff — which attribute changed, how, and to what value
moveOld and new DN
deleteEntry 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.

MODIFY events provide three representations of the change. All use delta semantics (what changed, not the full state):

FormatDescriptionWhen to use
diffAttribute-level operations: SET, ADD, REMOVEInternal processing, full detail
patchJSON Patch style with /attribute/- for array additionsJSON Patch-compatible consumers
mergeJSON Merge Patch style with changed values onlySimple 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.

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.