Skip to content

Identity resources · Kind catalogue · Examples

MFAMethod

API version: identity.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: mfamethods.identity.openbaoconfig.io
Categories: openbao

MFAMethod manages a login MFA method (TOTP, Duo, Okta or PingID) at `identity/mfa/method/<type>/<id>`. MFALoginEnforcement objects reference it to require a second factor at login.

Example:

spec:
  connectionRef:
    name: openbao
  name: totp-main
  totp:
    issuer: Example Corp
    period: 30s

Example

examples/identity/mfamethod.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
  name: obco-totp
  namespace: openbao-config
  labels:
    obco.example.com/mfa: required
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  deletionPolicy: Orphan
  name: obco-totp
  totp:
    issuer: OBCO Sandbox
    period: 30s
    keySize: 20
    qrSize: 200
    algorithm: SHA256
    digits: 6
    skew: 1
    maxValidationAttempts: 5
---
apiVersion: v1
kind: Secret
metadata:
  name: obco-duo-credentials
  namespace: openbao-config
type: Opaque
stringData:
  secret-key: fake-duo-secret-key-not-real
  integration-key: FAKEDUOINTEGRATIONKEY
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
  name: obco-duo
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  deletionPolicy: Orphan
  name: obco-duo
  duo:
    secretKeySecretRef:
      name: obco-duo-credentials
      key: secret-key
    integrationKeySecretRef:
      name: obco-duo-credentials
      key: integration-key
    apiHostname: api-fake0000.duosecurity.com
    pushInfo: from=openbao&env=sandbox
    usePasscode: true
    usernameFormat: "{{alias.name}}"
---
apiVersion: v1
kind: Secret
metadata:
  name: obco-okta-credentials
  namespace: openbao-config
type: Opaque
stringData:
  api-token: fake-okta-api-token-not-real
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
  name: obco-okta
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  deletionPolicy: Orphan
  name: obco-okta
  okta:
    orgName: obco-fake
    apiTokenSecretRef:
      name: obco-okta-credentials
      key: api-token
    baseURL: oktapreview.com
    primaryEmail: true
    usernameFormat: "{{entity.name}}@obco.example.com"
---
apiVersion: v1
kind: Secret
metadata:
  name: obco-pingid-settings
  namespace: openbao-config
type: Opaque
stringData:
  pingid.properties: |
    use_base64_key=ZmFrZS1rZXk=
    use_signature=true
    token=fake-token
    idp_url=https://idpxnyl3m.pingidentity.com/pingid
    org_alias=fake-org-alias
    admin_url=https://idpxnyl3m.pingidentity.com/pingid
    authenticator_url=https://authenticator.pingone.com/pingid/ppm
---
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: MFAMethod
metadata:
  name: obco-pingid
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  deletionPolicy: Orphan
  name: obco-pingid
  pingID:
    settingsFileSecretRef:
      name: obco-pingid-settings
      key: pingid.properties
    usernameFormat: "{{alias.name}}"

On GitHub: mfamethod.yaml, generated sample with every field.

Fields

Defaults below are CRD schema defaults. A blank cell does not imply zero, false or an empty value; see the field description for omission behaviour. Required fields inside an optional object apply only when that object is set.

FieldTypeRequiredDefaultDescriptionValidation
specobjectyesspec is the desired login MFA method at `identity/mfa/method/<type>/<id>`. OpenBao assigns the method ID, reported in `status.id`; the method is found again by its name. Set exactly one of totp, duo, okta and pingID; the type is immutable.
ConstraintsCEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)
CEL: [has(self.totp), has(self.duo), has(self.okta), has(self.pingID)].filter(x, x).size() == 1 (set exactly one of totp, duo, okta and pingID)
CEL: has(self.totp) == has(oldSelf.totp) && has(self.duo) == has(oldSelf.duo) && has(self.okta) == has(oldSelf.okta) && has(self.pingID) == has(oldSelf.pingID) (the method type is immutable)
CEL: has(self.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)
CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable)
spec.connectionRefobjectyesConnection used to reach and log in to OpenBao. Immutable.
spec.connectionRef.kindstringno"OpenBaoConnection"Kind of the connection: OpenBaoConnection (in the same Kubernetes namespace as this resource) or ClusterOpenBaoConnection (cluster-scoped; its allowedNamespaces must select this namespace). Default: OpenBaoConnection.
Constraintsone of: OpenBaoConnection, ClusterOpenBaoConnection
spec.connectionRef.namestringyesName of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao
Constraintslength: >=1, <=253
spec.creationPolicystringno"Create"How an object that already exists in OpenBao, and is not yet owned by this resource, is treated. Create (default): create the object; an existing one is refused with reason Conflict. Adopt: take over an existing object and never create one. CreateOrAdopt: create it, or take over an existing one. Settings that always exist in OpenBao (configuration singletons) need Adopt or CreateOrAdopt.
Constraintsone of: Create, Adopt, CreateOrAdopt
spec.deletionPolicystringno"Orphan"What happens in OpenBao when this resource is deleted. Orphan (default): the OpenBao object stays. Delete: the object is removed (a configuration singleton is reset to its defaults); data and key holders (mounts, namespaces, KV data, audit devices, endpoints, transit, PKI, SSH CA and TOTP keys, MFA methods, entities) are removed only while the resource carries the annotation openbaoconfig.io/allow-destructive-delete: "true". Kinds whose OpenBao object cannot be deleted reject Delete.
Constraintsone of: Delete, Orphan
spec.driftDetectionstringno"Enabled"Whether OpenBao is re-read periodically to detect and repair out-of-band changes. Enabled (default): re-read every driftInterval. Disabled: write only when the spec or a referenced Secret changes.
Constraintsone of: Enabled, Disabled
spec.driftIntervalstringnoHow often OpenBao is re-read for drift, as a duration of at least 30s. Default: the operator's interval for the kind (15m for kinds that grant access such as policies, auth mounts and roles, 1h for the rest), with jitter. Example: 30m
Constraintslength: <=32
CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s)
spec.duoobjectnoduo configures a Duo method. Immutable presence: the method type cannot change.
spec.duo.apiHostnamestringyesapiHostname is the Duo API host name (`api_hostname`). Example: `api-1a2b3c4d.duosecurity.com`.
Constraintslength: >=1, <=255
spec.duo.integrationKeySecretRefobjectyesintegrationKeySecretRef selects the Duo integration key (`integration_key`). Read from a Secret key; never stored in status. Write-only. Example: `{name: duo, key: integration-key}`.
spec.duo.integrationKeySecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.duo.integrationKeySecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.duo.pushInfostringnopushInfo is extra information sent with Duo push notifications, as URL-encoded key=value pairs (`push_info`). Example: `from=openbao&env=prod`.
Constraintslength: <=1024
spec.duo.secretKeySecretRefobjectyessecretKeySecretRef selects the Duo secret key (`secret_key`). Read from a Secret key; never stored in status. Write-only: a change is detected through the Secret, not read back. Example: `{name: duo, key: secret-key}`.
spec.duo.secretKeySecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.duo.secretKeySecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.duo.usePasscodebooleannousePasscode reminds users that they can enter a passcode; it does not enforce one (`use_passcode`). Defaults to false.
spec.duo.usernameFormatstringnousernameFormat maps an identity to the Duo user name (`username_format`). Empty uses the alias name as is. Example: `{{alias.name}}@example.com`.
Constraintslength: <=255
spec.managementPolicystringno"Manage"Whether the operator writes to OpenBao. Manage (default): converge OpenBao to the spec, create and delete as the policies say. Observe: only read the object and report drift in the conditions; never write or delete.
Constraintsone of: Manage, Observe
spec.namestringnoname is the method name in OpenBao (`method_name`), unique within the OpenBao namespace. Defaults to metadata.name. Immutable. Example: `totp-main`.
Constraintslength: >=1, <=128
spec.namespacestringnoOpenBao namespace of the object, relative to the connection's base namespace; empty means the connection namespace itself. Segments are separated by "/", without leading or trailing slash. Immutable: it cannot be added, changed or removed after creation. Example: team-a/apps
Constraintspattern: ^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$
length: <=256
spec.oktaobjectnookta configures an Okta method. Immutable presence: the method type cannot change.
spec.okta.apiTokenSecretRefobjectyesapiTokenSecretRef selects the Okta API token (`api_token`). Read from a Secret key; never stored in status. Write-only: a change is detected through the Secret, not read back. Example: `{name: okta, key: token}`.
spec.okta.apiTokenSecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.okta.apiTokenSecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.okta.baseURLstringnobaseURL is the base domain of the Okta API (`base_url`). Defaults to `okta.com`. Example: `oktapreview.com`.
Constraintslength: <=255
spec.okta.orgNamestringyesorgName is the Okta organisation name (`org_name`). Example: `example`.
Constraintslength: >=1, <=255
spec.okta.primaryEmailbooleannoprimaryEmail matches the user name against the primary email of the Okta account only (`primary_email`). OpenBao does not return it on read, so it is treated as write-only. Defaults to false.
spec.okta.usernameFormatstringnousernameFormat maps an identity to the Okta user name (`username_format`). Empty uses the entity name as is. Example: `{{entity.name}}@example.com`.
Constraintslength: <=255
spec.pingIDobjectnopingID configures a PingID method. Immutable presence: the method type cannot change.
spec.pingID.settingsFileSecretRefobjectyessettingsFileSecretRef selects the PingID settings file for third-party clients, as downloaded from Ping Identity, not base64-encoded (`settings_file_base64`, encoded by the operator). Read from a Secret key; never stored in status. Write-only. Example: `{name: pingid, key: pingid.properties}`.
spec.pingID.settingsFileSecretRef.keystringyesKey in the Secret's data whose value is used. Example: password
Constraintslength: >=1, <=253
spec.pingID.settingsFileSecretRef.namestringyesName of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials
Constraintslength: >=1, <=253
spec.pingID.usernameFormatstringnousernameFormat maps an identity to the PingID user name (`username_format`). Empty uses the alias name as is. Example: `{{alias.name}}`.
Constraintslength: <=255
spec.totpobjectnototp configures a time-based one-time password method. Immutable presence: the method type cannot change.
spec.totp.algorithmstringnoalgorithm is the hash algorithm of codes (`algorithm`). Allowed: SHA1, SHA256, SHA512. Defaults to SHA1.
Constraintsone of: SHA1, SHA256, SHA512
spec.totp.digitsinteger (int32)nodigits is the number of digits in a code (`digits`). Allowed: 6, 8. Defaults to 6.
Constraintsone of: 6, 8
spec.totp.issuerstringyesissuer is the organisation name shown in authenticator apps (`issuer`). Example: `Example Corp`.
Constraintslength: >=1, <=255
spec.totp.keySizeinteger (int32)nokeySize is the size in bytes of generated keys (`key_size`). 1-1024. Defaults to 20.
Constraintsvalue: >=1, <=1024
spec.totp.maxValidationAttemptsinteger (int32)nomaxValidationAttempts is the number of failed validations allowed before a user is locked out (`max_validation_attempts`). Minimum 1. Defaults to 5.
Constraintsvalue: >=1
spec.totp.periodstringnoperiod is the time step of a code (`period`), a duration. Defaults to `30s`. Example: `30s`.
spec.totp.qrSizeinteger (int32)noqrSize is the pixel size of generated QR codes; 0 disables them (`qr_size`). 0-4096. Defaults to 200.
Constraintsvalue: >=0, <=4096
spec.totp.skewinteger (int32)noskew is the number of periods before or after the current one that are accepted (`skew`). Allowed: 0, 1. Defaults to 1.
Constraintsvalue: >=0, <=1
statusobjectnostatus is the observed state of the MFA method; `id` holds the OpenBao method ID.
status.acquiredstringnoHow the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned.
status.conditions[]objectnoCurrent state as conditions: Ready (the OpenBao object matches the spec) and Synced (the last reconcile succeeded), each with a reason such as Available, Drifted, Conflict, ConnectionNotReady or PermissionDenied, and the generation it describes.
Constraintslist type: map (keys: type)
status.conditions[]objectnoCondition contains details for one aspect of the current state of this API Resource.
status.conditions[].lastTransitionTimestring (date-time)yeslastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
status.conditions[].messagestringyesmessage is a human readable message indicating details about the transition. This may be an empty string.
Constraintslength: <=32768
status.conditions[].observedGenerationinteger (int64)noobservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
Constraintsvalue: >=0
status.conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
Constraintspattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
length: >=1, <=1024
status.conditions[].statusstringyesstatus of the condition, one of True, False, Unknown.
Constraintsone of: True, False, Unknown
status.conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
Constraintspattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
length: <=316
status.idstringnoIdentifier OpenBao generated for the object (an entity, group or alias ID, or a mount accessor), for kinds that have one; other resources reference it. Example: 6c9f3e0a-1b2c-4d5e-8f90-123456789abc
status.namespacestringnoAbsolute OpenBao namespace the object was written in; empty means the root namespace. If it later differs from the spec, reconciling stops with reason NamespaceChanged. Example: team-a/apps
status.observedGenerationinteger (int64)noThe metadata.generation of this resource that the operator last reconciled.
status.pathstringnoFull OpenBao API path of the object, including its namespace, as last written; deletion uses it even after the spec changed. Example: team-a/sys/policies/acl/app-read
status.rotationNoncestringnoValue of the resource's rotation nonce when one-time inputs, such as a root credential that OpenBao rotates afterwards, were last sent; changing the nonce in the spec sends them again.
status.serverIDstringnoCluster ID of the OpenBao server the object was acquired on. If the connection later reaches another server, reconciling stops with reason ServerChanged and nothing is written or deleted. Example: 80f7de92-c12e-e960-4754-255c32fc6b53
status.writeOnlyHashstringnoKeyed hash (HMAC-SHA256) of the write-only inputs, such as passwords read from Secrets; a change forces a write. It never contains or reveals the values.