Skip to content

cayu.proxies.base

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.

from cayu.proxies import copy_proxy_authorization_result
copy_proxy_authorization_result(result: ProxyAuthorizationResult) -> ProxyAuthorizationResult

Release source · Runtime guarantees · Capability guides

from cayu.proxies import CredentialProxy

Credential boundary for trusted tools and environment integrations.

A proxy can resolve scoped secret references and authorize outbound actions without making raw credentials part of model-visible context. Generic sandbox command execution is not automatically routed through this contract.

Bases: ABC.

supports_webbridge_credential_authority (method)

Section titled “supports_webbridge_credential_authority (method)”
CredentialProxy.supports_webbridge_credential_authority(authority: WebBridgeCredentialAuthority) -> bool

Declare side-effect-free compatibility with one hosted WebBridge authority.

async CredentialProxy.resolve(ref: SecretRef, *, scope: dict[str, Any] | None=None) -> ResolvedSecret

Resolve a secret reference at the credential boundary.

async CredentialProxy.authorize_request(*, destination: str, credential: SecretRef | None=None, action: str | None=None, metadata: dict[str, Any] | None=None) -> ProxyAuthorizationResult

Return whether an outbound action is allowed.

Release source · Runtime guarantees · Capability guides

from cayu.proxies import ProxyAuthorizationResult

Result of a credential proxy outbound authorization check.

Bases: BaseModel.

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
allowed StrictBool required
reason str | None None
metadata dict[str, Any] Field(default_factory=dict)
ProxyAuthorizationResult.validate_optional_reason(value: str | None, info) -> str | None
ProxyAuthorizationResult.copy_metadata(value: dict[str, Any]) -> dict[str, Any]
ProxyAuthorizationResult.require_reason_for_denial() -> ProxyAuthorizationResult

Release source · Runtime guarantees · Capability guides