@grow-codes/hashicorp-vault - v0.1.1
    Preparing search index...

    Class Sys

    System backend: client.sys. Most write calls need a privileged (root/sudo) token.

    Index
    • The capabilities of another token on each path: POST sys/capabilities (the caller needs update on sys/capabilities; otherwise PermissionDeniedError).

      Parameters

      Returns Promise<Capabilities>

    • The capabilities of the client token on each path: POST sys/capabilities-self. Returns a map from each requested path to its capabilities (create, read, update, patch, delete, list, sudo, root or deny), so callers can check a policy before acting.

      const caps = await client.sys.capabilitiesSelf(["secret/data/app/db"]);
      if (caps.allows("secret/data/app/db", Capability.Read)) { ... }

      Parameters

      Returns Promise<Capabilities>

    • Creates or updates an AppRole role: POST auth/<mount>/role/<name>.

      Parameters

      Returns Promise<void>

    • Disables an auth method; its tokens are revoked.

      Parameters

      Returns Promise<void>

    • Disables (unmounts) a secrets engine; its data is deleted.

      Parameters

      Returns Promise<void>

    • Enables an auth method at path.

      Parameters

      Returns Promise<void>

    • Enables a secrets engine at path. A used path raises ValidationError.

      Parameters

      Returns Promise<void>

    • Server version from sys/health; UnsupportedError when the server reports none.

      Parameters

      Returns Promise<string>

    • Creates or replaces an ACL policy: PUT sys/policies/acl/<name>.

      Parameters

      Returns Promise<void>