@openvireo/sdk - v1.0.0
    Preparing search index...

    Class ServiceAccount

    Index
    core: ServiceAccount

    The core's service account handle.

    • get issuer(): string

      Returns string

    • get principal(): string

      Returns string

    • get saId(): string

      Returns string

    • Wipes the keyset, vault keys and secret (best effort).

      Returns void

    • Runs fn on the open vault, then syncs the change up (needs write). Edits of one vault run one at a time.

      Type Parameters

      • T

      Parameters

      • idOrName: string
      • fn: (vault: Vault) => T | Promise<T>

      Returns Promise<T>

    • Replaces every ov:// reference in a template (ov inject / run --env-file).

      Parameters

      • template: string

      Returns Promise<{ secrets: string[]; text: string }>

    • The vaults this service account can open (cached; refresh asks again).

      Parameters

      • refresh: boolean = false

      Returns Promise<SaVault[]>

    • Opens a vault (downloaded once, then cached; refresh downloads again).

      Parameters

      • idOrName: string
      • refresh: boolean = false

      Returns Promise<Vault>

    • Downloads the vault again and returns it.

      Parameters

      • idOrName: string

      Returns Promise<Vault>

    • Reads ov://<vault>/<entry>/<field>.

      Parameters

      • ref: string

      Returns Promise<string>

    • A vault by id or (unique) name.

      Parameters

      • idOrName: string

      Returns Promise<SaVault>

    • Writes a field (needs write) with the conditional PUT and merge/retry loop.

      Parameters

      • ref: string
      • value: string
      • opts: { create?: boolean } = {}

      Returns Promise<void>