Skip to main content

Connector reference

Every field, operation and rule a connector uses. The path pages link here at the point you need each fact. Machine-readable JSON Schemas are published alongside, so a script or an agent can check its output directly.

ReferenceCoversJSON Schema
Connector manifestEvery field of manifest.json: identity, capabilities, placement, authentication, configuration, entities, Grant kinds, custom operations, rate limitsmanifest.schema.json
LDAP definitionEvery field of an LDAP connector's definition.jsonldap.schema.json
SCIM definitionEvery field of a SCIM connector's definition.jsonscim.schema.json
SQL definitionEvery field of a SQL connector's definition.jsonsql.schema.json
Flat-file definitionEvery field of a flat-file connector's definition.jsonflat-file.schema.json
Handler APIHandler keys and signatures, the ctx object, errors, predicates, pagination options, hooks
ExpressionsThe expression syntax, its functions, and the values each place that takes an expression can read
Grant write contractWhen an add or remove may report "already there" or "already gone"
Validation issuesEvery issue code Owlie reports, what it means and how to fix it
Pack formatThe one-file JSON form of a connector used by export and import, its path rules and limitspack.schema.json