Schema introspection
Every command below with arguments supports two read-only flags for tooling and AI agents:--show-file-schema: print the JSON Schema for the full request object (the format--filenameaccepts).--show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading--(e.g.org-id, not--org-id).
get
Get an organization’s roles manifest
Return the latest version of an organization’s roles manifest: the YAML that defines its
roles and the permissions each one grants, as the organization settings page in the
HoneyHive app shows it. The organization is identified by the org_id path parameter
alone. The x-hh-org-id header does not participate.
Available on self-hosted deployments only. Elsewhere this operation returns 404. An API key
that carries org.roles.get or org.roles.set can carry no permission other than the
roles and membership permissions, and is created on an organization.
Usage
Options
Also supports
--show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.
update
Replace an organization’s roles manifest
Save a new version of an organization’s roles manifest, which becomes the latest version.
Every member’s current session must reauthorize, so the new roles apply to everyone
immediately. The organization is identified by the org_id path parameter alone. The
x-hh-org-id header does not participate.
When an API key makes the request, two further rules apply:
- If the organization’s current roles manifest already has this content, nothing is saved and that version is returned, so applying the same manifest repeatedly is safe.
- A manifest that would leave no onboarded, active member holding
org.roles.get,org.roles.set,org.fine_grained_api_key_cp.listandorg.fine_grained_api_key_cp.deleteis refused with 409, so someone in the organization can always revoke the key.
org.roles.get or org.roles.set can carry no permission other than the
roles and membership permissions, and is created on an organization.
Usage
Options
Also supports
--show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.