Skip to content

cayu.collaboration.access

Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.

CollaborationAccessContext

Section titled “CollaborationAccessContext”
from cayu.collaboration import CollaborationAccessContext

Supplied by trusted SDK host code, never taken from a model/JSON request.

Bases: ContractValue.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
principal Identifier required

bounded_input (method)

Section titled “bounded_input (method)”
CollaborationAccessContext.bounded_input(value: object) -> Any

immutable_fields (method)

Section titled “immutable_fields (method)”
CollaborationAccessContext.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

CollaborationAccessDenied

Section titled “CollaborationAccessDenied”
from cayu.collaboration import CollaborationAccessDenied

The trusted access boundary did not authorize this operation.

Bases: PermissionError.

This type’s implementation and inherited behavior are available in the linked release source.

Release source · Runtime guarantees · Capability guides

CollaborationAccessGrant

Section titled “CollaborationAccessGrant”
from cayu.collaboration import CollaborationAccessGrant

Policy-owned result. None means this entire scope; empty means no participants.

Bases: ContractValue.

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
application_scope Identifier required
participants tuple[ParticipantRef, ...] | None Field(default=(), max_length=64)

bounded_input (method)

Section titled “bounded_input (method)”
CollaborationAccessGrant.bounded_input(value: object) -> Any

immutable_fields (method)

Section titled “immutable_fields (method)”
CollaborationAccessGrant.immutable_fields() -> ContractValue

Release source · Runtime guarantees · Capability guides

CollaborationAccessPolicy

Section titled “CollaborationAccessPolicy”
from cayu.collaboration import CollaborationAccessPolicy

Bases: ABC.

authorize (method)

Section titled “authorize (method)”
CollaborationAccessPolicy.authorize(context: CollaborationAccessContext, *, application_scope: str, action: ParticipantAction) -> CollaborationAccessGrant

Resolve application-owned permissions without external side effects.

Release source · Runtime guarantees · Capability guides

CollaborationRegistration

Section titled “CollaborationRegistration”
from cayu.collaboration import CollaborationRegistration

Decorators: @dataclass(frozen=True).

Fields and attributes

Section titled “Fields and attributes”

Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.

Name Type Default
bootstrap CollaborationBootstrap required
access_policy CollaborationAccessPolicy required
configurations tuple[ParticipantConfiguration, ...] required

Release source · Runtime guarantees · Capability guides