Skip to main content

Organization

Your organization's profile, email domains, IP allowlist, setup progress, data region, retention windows, SIEM export, staging org, HIPAA warnings, schedule and outcome scan intervals, NodeLinks and their storage, settings, and deleting the organization. These endpoints act on the caller's own organization.

๐Ÿ“„๏ธDelete NodeLink storage

Deletes a NodeLink storage no NodeLink uses (409 otherwise; Jaah-managed storage is refused); without `delete_in_cloud` only Jaah's record goes and the file system or instance stays in the cloud, still billed. With it, storage Jaah created (422 for storage it did not) is deleted in the cloud with its files: an EFS file system with its mount targets and security group, or a Filestore instance. Returns 204 once gone, or 202 with the storage `deleting` and `last_error` naming any refusal while the cloud finishes (a repeat call retries); requires permission to edit credentials.

๐Ÿ“„๏ธShare subscriptions between nodes

Creates a NodeLink named `name` (default `Subscriptions`) at `{jaah-home}/auth/.shared` on `storage`, attaches every Linux node of the organization the caller may attach, or only those of them in `node_ids` (`skipped` lists the rest with a reason), and requests its provisioning, which finishes without another call; a step that fails undoes the create. `consent` must be true, confirming the caller's model provider allows one subscription on several devices, and is recorded in the audit log. Returns 201 with the new NodeLink, or 200 with the organization's existing one at that path and nothing changed; requires permission to edit credentials.

๐Ÿ“„๏ธDelete a NodeLink

Deletes a NodeLink or retries a delete in progress: nodes unmount it first, its files stay in the file system, an access point it took from **Use existing** stays in AWS, and storage no NodeLink uses any more is removed from Jaah, unless Jaah created it in the cloud: that stays, still billed, until it is deleted with `delete_store`. Returns 204 once it is gone, or the NodeLink still `deleting` with `last_error` naming any node still holding it after ten minutes or what AWS refused. Requires permission to edit credentials.

๐Ÿ“„๏ธSet a NodeLink's storage

Chooses where a NodeLink lives before its access point exists: one of the organization's storages (`store_id`), new storage Jaah creates (`create`), an existing file system (`existing`) or Jaah-managed storage (`managed`, which starts provisioning at once), plus optionally an existing access point (`access_point_id`, never with `managed`), each existing choice checked against AWS (422 names a mismatch). Returns the NodeLink, or 409 once it has an access point or when Jaah-managed storage is not available. Requires permission to edit credentials and reach to the AWS credential, which Jaah-managed storage does not need.

๐Ÿ“„๏ธSet IP ranges

Replaces the organization's IP allowlist with `ranges`, each a `cidr` (IPv4 or IPv6; a bare address is one host) and an optional `label`, and returns it; an empty list turns it off. With any range saved, its people may use the console and API only from inside one, while node and runner traffic is never blocked. Refused with 422 for an invalid or duplicate range or a list that leaves out the caller's own address, and with 403 without the Org Owner or Org Admin role or the IP allowlist on the plan.

๐Ÿ“„๏ธSet retention

Sets the organization's retention windows in days for `transcripts` (session transcripts), `events` (activity events; security events are kept at least 365 days) and `artifacts` (task artifacts); null keeps the platform default; a window can only be shorter than the platform's. The nightly retention sweep then deletes the organization's older data. Refused with 422 naming the allowed range for a value outside it, and with 403 without the Org Owner or Org Admin role or Retention on the plan.

๐Ÿ“„๏ธGet SIEM export

Returns the organization's SIEM export destination, or `destination: null` when none is saved: its `url`, `auth_mode` (`hmac` or `header`), `header_name`, `enabled`, `secret_set` (the secret itself is never returned), the latest delivery (`last_attempt_at`, `last_success_at`, `last_status`, `last_error`), `pending` (events not delivered yet, counted up to `pending_cap` + 1), `settling` (those under two minutes old, not sent yet) and `retention_warning` when a failure outlasted the activity retention. Requires the Org Owner or Org Admin role (else 403); allowed when the plan no longer includes SIEM export, so a saved destination can be found and removed.

๐Ÿ“„๏ธSet SIEM export

Creates or replaces the organization's SIEM export destination: an `https://` `url` on a public address, `auth_mode` `hmac` (each POST carries `X-Jaah-Signature: sha256=<hex HMAC-SHA256 of the body>`) or `header` (the `secret` sent as the value of `header_name`), the `secret` (required on create or when `auth_mode` changes; omitted keeps the stored one), and `enabled`. Every minute the organization's new activity events (those its Audit page shows) are POSTed as a JSON array (`id`, `org_id`, `created_at`, `kind`, `action_type`, `actor`, `summary`, `path`, `method`, `status`, `data`), at least once: a non-2xx answer is retried the next minute, so dedupe on `id`. Refused with 422 naming what to fix for a non-https or private URL, a reserved header or a short secret, and with 403 without the Org Owner or Org Admin role or SIEM export on the plan.