Skip to content

Identity resources · Kind catalogue · Examples

OIDCClient

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

OIDCClient manages an application that logs users in through the OpenBao OIDC provider, at `identity/oidc/client/<name>`. Use it with an OIDCProvider, an OIDCAssignment and writeSecretRef to hand the generated client ID and secret to the application.

Example:

spec:
  connectionRef:
    name: openbao
  name: grafana
  redirectURIs:
    - https://grafana.example.com/login/generic_oauth
  assignments: [billing-users]
  writeSecretRef:
    name: grafana-oidc

Example

examples/identity/oidcclient.yaml
apiVersion: identity.openbaoconfig.io/v1alpha1
kind: OIDCClient
metadata:
  name: obco-portal
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  driftDetection: Enabled
  driftInterval: 30m
  managementPolicy: Manage
  deletionPolicy: Delete
  name: obco-portal
  key: obco-signing-key
  clientType: confidential
  redirectURIs:
    - https://portal.obco.example.com/oidc/callback
    - http://localhost:8250/oidc/callback
  assignments:
    - obco-portal-users
  idTokenTTL: 30m
  accessTokenTTL: 1h
  authorizationCode: true
  clientCredentials: true
  writeSecretRef:
    name: obco-portal-oidc-credentials

On GitHub: oidcclient.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 client of the OpenBao OIDC provider at `identity/oidc/client/<name>`. OpenBao generates the client ID and, for a confidential client, the client secret; set writeSecretRef to receive them.
ConstraintsCEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)
CEL: has(self.key) == has(oldSelf.key) && (!has(self.key) || self.key == oldSelf.key) (key is immutable)
CEL: has(self.clientType) == has(oldSelf.clientType) && (!has(self.clientType) || self.clientType == oldSelf.clientType) (clientType is immutable)
CEL: !(has(self.clientType) && self.clientType == 'public' && has(self.clientCredentials) && self.clientCredentials) (clientCredentials requires clientType confidential)
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.accessTokenTTLstringnoaccessTokenTTL is the lifetime of access tokens (`access_token_ttl`), a duration. Defaults to `24h`. Example: `1h`.
spec.assignments[]stringnoassignments are the names of OIDC assignments that select the entities and groups allowed to use the client (`assignments`). Each must exist; `allow_all` allows every entity. Up to 64. Example: `[billing-users]`.
Constraintsitems: <=64
list type: set
each item: length: >=1, <=128
spec.authorizationCodebooleannoauthorizationCode allows the authorization code flow (`authorization_code`). Defaults to true.
spec.clientCredentialsbooleannoclientCredentials allows the client credentials flow (`client_credentials`); confidential clients only. Defaults to false.
spec.clientTypestringno"confidential"clientType is `confidential` (the client holds a client secret) or `public` (`client_type`). Defaults to confidential. Immutable.
Constraintsone of: confidential, public
length: <=16
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.idTokenTTLstringnoidTokenTTL is the lifetime of ID tokens (`id_token_ttl`), a duration. Must not exceed the key's verificationTTL. Defaults to `24h`. Example: `1h`.
spec.keystringno"default"key is the name of the OIDC key that signs the client's tokens (`key`); an OIDCKey or the built-in `default`. Defaults to `default`. Immutable. Example: `apps`.
Constraintslength: >=1, <=128
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 client name in OpenBao. Defaults to metadata.name. Letters, digits, `_`, `.`, `@` and `-`. Immutable. Example: `grafana`.
Constraintspattern: ^\w([\w.@-]*\w)?$
length: >=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.redirectURIs[]stringnoredirectURIs are the allowed redirect URIs (`redirect_uris`); a request's redirect_uri must match one exactly. Up to 64. Example: `[https://grafana.example.com/login/generic_oauth]`.
Constraintsitems: <=64
list type: set
each item: length: >=1, <=512
spec.writeSecretRefobjectnowriteSecretRef names a Secret in the resource's namespace that the operator creates and owns, with the keys `client_id` and, for a confidential client, `client_secret`. The secret is never stored in status. Example: `{name: grafana-oidc}`.
spec.writeSecretRef.namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
statusobjectnostatus is the observed state of the OIDC client; `id` holds the client 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.