Skip to content

site_capabilities

An organisation's capabilities on its own hardware: the site agreement, their state, and requests for them.

Running analyses on the organisation's own hardware and keeping recordings at its site are off until a platform administrator turns each on. An administrator does so against the owner's acceptance of the latest published site agreement, or for an organisation the platform operates itself. An owner may ask for a capability; the request reaches the platform's administrators. An analysis its configuration keeps on the platform runs at an organisation's site only under an exception an administrator records.

CapabilityRequestCreate pydantic-model

Bases: BaseModel

An owner's request for a capability.

Fields:

note = '' pydantic-field

What the organisation wants to use it for, for the administrators.

CapabilityRequestDecision pydantic-model

Bases: BaseModel

An administrator's decision on a request.

Fields:

  • decision (Literal['approved', 'declined'])
  • reason (str | None)
  • decided_at (datetime)

reason = None pydantic-field

Why the request was declined; None for an approval.

CapabilityRequestOut pydantic-model

Bases: BaseModel

A request for a capability, with its decision once made.

Fields:

note pydantic-field

What the organisation wants to use it for.

requested_by = None pydantic-field

Who asked; None once that account is gone.

CapabilityRequestPage pydantic-model

Bases: BaseModel

A page of an organisation's requests for capabilities, newest first.

Fields:

CapabilityStatus pydantic-model

Bases: BaseModel

Where an organisation stands with one capability.

Fields:

changed_at = None pydantic-field

When an administrator last turned it on or off; None if never.

request_id = None pydantic-field

The request awaiting a decision, while the state is 'requested'.

OrganizationCapabilities pydantic-model

Bases: BaseModel

An organisation's capabilities on its own hardware, and the agreement they rest on.

Fields:

acceptance = None pydantic-field

The organisation's latest acceptance of the site agreement.

capabilities pydantic-field

Each capability's state, one entry per capability.

platform_operated pydantic-field

Whether the platform operates the organisation itself; such an organisation needs no acceptance of the site agreement.

site_agreement_version pydantic-field

The latest published version of the site agreement; None while none is published, when nothing can be accepted.

SiteAgreementAccept pydantic-model

Bases: BaseModel

The owner's acceptance of the site agreement, at the version they read.

Fields:

version pydantic-field

The version accepted; it must be the latest published one.

SiteAgreementAcceptance pydantic-model

Bases: BaseModel

An acceptance of the site agreement, as recorded.

Fields:

  • org_id (UUID)
  • version (int)
  • accepted_by (UUID | None)
  • accepted_by_name (str | None)
  • accepted_at (datetime)

accepted_by = None pydantic-field

Who accepted it, on the organisation's behalf; None once that account is gone.

version pydantic-field

The version accepted.

SiteExceptionCreate pydantic-model

Bases: BaseModel

A platform administrator's record that an organisation may run a platform-only analysis at its site.

It covers every version of the analysis until it expires or is revoked.

Fields:

agreement_reference pydantic-field

The agreement that protects the analysis's image at the site.

analysis_config_id pydantic-field

The analysis, by its machine-readable id.

expires_at pydantic-field

When the exception ends; it must be in the future.

SiteExceptionOut pydantic-model

Bases: BaseModel

One record of an exception: recorded, or revoked.

Records only grow. The latest for an organisation and an analysis is its state: in force while it is recorded, not revoked, and unexpired.

Fields:

agreement_reference = None pydantic-field

The agreement it rests on; None on a revocation.

expires_at = None pydantic-field

When it ends; None on a revocation.

in_force pydantic-field

Whether this record is the latest for its analysis, is not a revocation, and has not expired.

reason = None pydantic-field

Why it was revoked; None when recorded.

recorded_by pydantic-field

The administrator who recorded it.

revoked pydantic-field

Whether this record revokes the exception.

SiteExceptionPage pydantic-model

Bases: BaseModel

A page of an organisation's exception records, newest first.

Fields:

SiteExceptionRevoke pydantic-model

Bases: BaseModel

A platform administrator ending an exception before it expires.

Fields:

reason pydantic-field

Why it ends, kept with the record.