API reference
tenancy/owner-key
Import
Section titled “Import”import * as api from "@fungi.computer/oyster/tenancy/owner-key";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | OwnerKeyRecord | Stored owner verification material for one selected tenant. |
| type alias | OwnerKeyOptions | Live owner authority and host-held verification material. |
| function | ownerKey() | Reuse Oyster verification and admit only a current, explicitly stored owner. |
OwnerKeyRecordtype alias
Section titled “OwnerKeyRecord”type OwnerKeyRecord = Readonly<{ key: string; memberId: string;}>;Stored owner verification material for one selected tenant.
OwnerKeyOptionstype alias
Section titled “OwnerKeyOptions”type OwnerKeyOptions = Readonly<{ registry: Pick<ReadonlyTenantRegistry, "get">; keys: Readonly<{ get: Promise<Readonly<{ key: string; memberId: string; }> | null>; }>; login?: Readonly<{ resolveTenant: ReadonlyTenancy["resolve"]; }>;}>;Live owner authority and host-held verification material.
ownerKey()function
Section titled “ownerKey()”function ownerKey(options): AuthAdapter;Reuse Oyster verification and admit only a current, explicitly stored owner.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options |
OwnerKeyOptions |