Skip to main content

Organizations

An organization is the top-level tenant in Perpetual, identified by an ORG_-prefixed resource ID. Each interactive session in Perpetual is always rooted within one organization.

Every Space, every piece of content, every dataset, and every setting belongs to exactly one organization, and none of these cross the boundary between two. A user is the exception. Users exist outside any single organization and reach an organization through a membership, so one user can belong to several organizations at once. The membership carries the roles that decide what the user can do inside that organization. The organization holds the account-level settings that govern AI features, single sign-on, and automated alert triage for everything it contains.

Members​

A user belongs to an organization through a membership. What the membership grants comes from the roles assigned to it. An organization owner manages memberships from the organization side (in the web app, on the organization's members settings): adding a member, setting that member's roles, and removing a member.

Inputs​

The fields the caller provides on create or update.

FieldTypeRequiredDescription
namestringRequiredDisplay name of the organization. Unique across all organizations.
perpetualBedrockEnabledbooleanOptionalWhether the organization uses Perpetual's managed Bedrock as its AI provider instead of a self-provided Anthropic key. Set by a superuser through the Perpetual Bedrock settings endpoint.
triageEnabledbooleanOptionalWhether automated AI alert triage runs for the organization. Set by a superuser through the triage settings endpoint.
ssoEnabledbooleanOptionalWhether single sign-on is enabled for the organization.
spaceNamestringRequiredDisplay name of the initial Space. Create only.
spaceCatalogNamestringRequiredStorage namespace segment for the initial Space. Create only. Only lowercase letters, numbers, and underscores.
anthropicApiKeystringOptionalAnthropic API key to set on the organization. Available on create and update. Never returned.
virusTotalApiKeystringOptionalVirusTotal API key to set on the organization. The Simba agent uses it to look up indicators of compromise. Available on create and update. Never returned.

Outputs​

The full shape the API returns.

FieldTypeDescription
hasAnthropicApiKeybooleantrue when an Anthropic API key is set on the organization.
hasVirusTotalApiKeybooleantrue when a VirusTotal API key is set.
hasAiProviderConfiguredbooleantrue when the organization has an AI provider available for the Simba agent. It is true when perpetualBedrockEnabled is true or an Anthropic API key is set.

Plus the common resource fields.

  • Users, the identities that join an organization through a membership.
  • Roles, the named access grants assigned to a membership.
  • Spaces, the access-controlled namespaces an organization is partitioned into.
  • Content, the authored resources an organization owns through its Spaces.
  • Dataset resources, the datasets an organization owns through its Spaces.