Skip to content

sys.openbaoconfig.io

Audit, AuditRequestHeader, AuthMount, CORSConfig, KeyRotationConfig, Logger, OpenBaoNamespace, PasswordPolicy, Plugin, Policy, QuotaConfig, RaftAutopilot, RateLimitQuota, SecretsMount, UIHeader, Workflow

Choose a kind for its complete field reference, validation rules and tested example manifests.

Audit

Audit enables an OpenBao audit device at sys/audit/<path>, in the root namespace only; every field is immutable.

Audit fields and YAML example · Example gallery

AuditRequestHeader

AuditRequestHeader makes the OpenBao audit devices record an HTTP request header, at sys/config/auditing/request-headers/<name>, in the root namespace only.

AuditRequestHeader fields and YAML example · Example gallery

AuthMount

AuthMount enables and tunes an OpenBao auth method at sys/auth/<path> (logins then go to auth/<path>/login).

AuthMount fields and YAML example · Example gallery

CORSConfig

CORSConfig enables cross-origin (CORS) requests to OpenBao at sys/config/cors, a server-wide singleton in the root namespace.

CORSConfig fields and YAML example · Example gallery

KeyRotationConfig

KeyRotationConfig sets the automatic rotation of the barrier encryption key (the key that encrypts OpenBao storage, not a secret) at sys/rotate/config, a singleton of the root namespace or a sealable namespace.

KeyRotationConfig fields and YAML example · Example gallery

Logger

Logger sets the runtime log level of one named OpenBao logger at sys/loggers/<name>, for example to debug one subsystem without restarting the server.

Logger fields and YAML example · Example gallery

OpenBaoNamespace

OpenBaoNamespace creates an OpenBao namespace at sys/namespaces/<name> inside the parent namespace selected by namespace (the connection namespace when unset).

OpenBaoNamespace fields and YAML example · Example gallery

PasswordPolicy

PasswordPolicy manages an OpenBao password policy at sys/policies/password/<name>: the rules secrets engines (database, LDAP and others) and RandomSecret use to generate passwords.

PasswordPolicy fields and YAML example · Example gallery

Plugin

Plugin registers an external plugin in the OpenBao plugin catalog at sys/plugins/catalog/<type>/<name>, so mounts can use it.

Plugin fields and YAML example · Example gallery

Policy

Policy manages an OpenBao ACL policy at sys/policies/acl/<name>, which grants capabilities on paths to the tokens it is attached to.

Policy fields and YAML example · Example gallery

QuotaConfig

QuotaConfig manages the server-wide rate-limit quota settings at sys/quotas/config: exempt paths, audit logging of rejections and response headers.

QuotaConfig fields and YAML example · Example gallery

RaftAutopilot

RaftAutopilot manages the raft autopilot settings at sys/storage/raft/autopilot/configuration: dead server cleanup, health thresholds and voter promotion.

RaftAutopilot fields and YAML example · Example gallery

RateLimitQuota

RateLimitQuota manages an OpenBao rate limit quota at sys/quotas/rate-limit/<name>, which caps the request rate globally or for one namespace, mount, path or auth role.

RateLimitQuota fields and YAML example · Example gallery

SecretsMount

SecretsMount enables and tunes an OpenBao secrets engine at sys/mounts/<path>, such as a KV, PKI, transit or database engine.

SecretsMount fields and YAML example · Example gallery

UIHeader

UIHeader manages a custom HTTP response header that OpenBao returns with its web UI, at sys/config/ui/headers/<name>, for example a Content-Security-Policy.

UIHeader fields and YAML example · Example gallery

Workflow

Workflow manages an OpenBao workflow at sys/workflows/manage/<path>: a declarative sequence of API requests (a profile) that callers run through sys/workflows/execute/<path>.

Workflow fields and YAML example · Example gallery