Niah Docs
Reference

Changelog

Notable contract revisions for the Niah API and SCIM service.

2026-07-30

  • Added public /v1/tasks, /v1/task_lists, /v1/documents, /v1/integrations, and /v1/members (plus invitations), with matching API-key scopes.
  • Fixed registered webhook fan-out: enabled /v1/webhooks configs now receive matching events, signed as x-niah-signature: sha256=<hex>.
  • SCIM User PATCH operation names are now case-insensitive, including Replace, Add, and Remove.
  • userName eq "…" filtering now runs in the database before pagination and reports a filtered totalResults.
  • Published tested SCIM recipes for Okta, Microsoft Entra ID, and JumpCloud.
  • Clarified deactivate-only user deprovisioning. User DELETE remains unsupported.
  • Aligned scope-denial documentation with the runtime insufficient_scope error code.

Responses for this revision carry X-API-Version: 2026-07-30.

Version policy

  • Stable API generations are selected by URL, currently /v1.
  • Additive fields, endpoints, and backward-compatible fixes can ship within the current generation.
  • Breaking changes require a new URL generation, a documented migration path, and an announced transition window.
  • X-API-Version is a response-only deployment revision. Clients must not send it as a version selector.