Devices

auth.devices(relay_url, name) returns this device on the relay, its key in the session's credential store (shared with the cua CLI and daemon). A device lists and reaches the account's machines once enrolled: right after a fresh sign-in (a sign-in through Auth.begin_login re-registers a device that already has a key), or by a one-time code approved from an enrolled device (cua devices approve). A new key of the same machine replaces its old record. Enrollment lasts 30 days, then one approval or a fresh sign-in re-verifies it. Nothing here prompts; gate approve behind presence in your UI.

Devices#

This device as a client of the signed-in account on a relay: its enrollment, the account's other devices and its audit log. The device key lives in the session's vault (shared with the cua CLI and daemon). Nothing here prompts: approving is the caller's to gate behind presence.

Returned by Auth.devices.

Devices.approve#

Approves the device showing code, or re-verifies device_id, from this enrolled device.

async def approve(self, code: Optional[str], device_id: Optional[str]) -> RelayDevice

Returns RelayDevice · Async · Raises CuaError

Devices.check_enrolled#

Whether the relay lets this device open a session now (enrolled), asked afresh. Polled while waiting for an approval.

async def check_enrolled(self) -> bool

Returns bool · Async

Devices.confirm_machine#

Vouches for machine_id, a machine that registered without an enrolled device's signature or MFA (from this enrolled device) (S5). Clears RelayMachine.confirmed's "new" flag for every account member, not just this device.

async def confirm_machine(self, machine_id: str) -> RelayMachine

Returns RelayMachine · Async · Raises CuaError

Devices.device_id#

This device's id, when it has a key (no network).

def device_id(self) -> Optional[str]

Returns Option<String> · Raises CuaError

Devices.enroll#

Registers this device (creating its key on first use). Right after a fresh sign-in it is enrolled at once (replacing this machine's older device key, if any); otherwise the result carries a one-time code to approve from an enrolled device.

async def enroll(self) -> DeviceEnrollment

Returns DeviceEnrollment · Async · Raises CuaError

Devices.rename#

Renames a device (from this enrolled device).

async def rename(self, id: str, name: str) -> RelayDevice

Returns RelayDevice · Async · Raises CuaError

Devices.revoke#

Revokes a device (from this enrolled device). Revoking this device also deletes its key.

async def revoke(self, id: str) -> RelayDevice

Returns RelayDevice · Async · Raises CuaError

Devices.snapshot#

The account's devices, the grace period, the newest audit_limit audit events and the machines' names. Only the device list must succeed; the rest is empty when the relay refuses it.

async def snapshot(self, audit_limit: int) -> DevicesSnapshot

Returns DevicesSnapshot · Async · Raises CuaError

DevicesSnapshot record#

Everything the Devices page reads, in one call.

Returned by Devices.snapshot.

RelayDevice record#

A client device of the account, as the relay lists it.

Returned by Devices.approve, Devices.rename, Devices.revoke.

RelayAuditEvent record#

One event of the account's audit log.

DeviceEnrollment record#

Devices.enroll's result.

Returned by Devices.enroll.