platform-biomes-enablement

Operations of the Biome Host API. Paths are relative to your deployment's API host.

GET /api/biome-host-api/platform/biomes/enablement

Resolved per-org governance view for every registered biome. Folds in kernel/mandatory rules; consumers MUST treat this as the single source of truth.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
orgquerystringno
StatusDescriptionBody
200application/json OrgBiomeEffectiveEnablementDtoDataArrayEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

POST /api/biome-host-api/platform/biomes/enablement/backfill

Additively enable any newly default-selected (or required) biome the caller's org is missing. Idempotent, never disables/overwrites an existing admin decision, never enables optional biomes. Returns how many rows were added.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
orgquerystringno
StatusDescriptionBody
200application/json BackfillEnablementResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

GET /api/biome-host-api/platform/biomes/enablement/{biomeId}

One biome's resolved governance verdict for the caller's org, computed on every call (never cached). Callers that widen or keep authority on the answer MUST use this read, not the cached list. 404 for a biome this build does not register.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
biomeIdpathstringyes
orgquerystringno
StatusDescriptionBody
200application/json OrgBiomeEffectiveEnablementDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404The biome is not registered in this build.application/problem+json BiomeEnablementNotFoundProblemDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto

PATCH /api/biome-host-api/platform/biomes/enablement/{biomeId}

Toggle a biome's state or surfaceMode for the caller's org. A person's own token needs the enablement write permission (org admins hold it by default). Refused (409) for kernel + mandatory biomes (PLUGIN_DISABLE_FORBIDDEN) and for an operator biome the deployment's package list does not name (PLUGIN_NOT_LISTED).

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
biomeIdpathstringyes
orgquerystringno

Request body: application/json UpdateOrgBiomeEnablementDto

StatusDescriptionBody
200application/json OrgBiomeEffectiveEnablementDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto