Authentication resources · Kind catalogue · Examples
JWTAuthRole¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: jwtauthroles.auth.openbaoconfig.io
Categories: openbao
JWTAuthRole manages a role of an OpenBao JWT/OIDC auth method at auth/<mountPath>/role/<name>. Use it to map JWT claims (CI jobs, workload identities) or OIDC browser logins to tokens with the listed policies.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: jwt
userClaim: sub
boundAudiences: [openbao]
boundClaims: {project_path: [iam/vault-stack]}
tokenPolicies: [ci-read]
tokenTTL: 15mExample¶
examples/auth/jwtauthrole.yaml
# Lets CI jobs of the protected main branch of platform/app log in on the jwt-ci mount with their job JWT: the
# subject, audience and claims are bound, and the project path and ref become token metadata.
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: JWTAuthRole
metadata:
name: ci-deploy
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: jwt-ci
name: ci-deploy
roleType: jwt
userClaim: sub
userClaimJSONPointer: false
boundAudiences:
- https://openbao.example.com
boundSubject: project_path:platform/app:ref_type:branch:ref:main
boundClaimsType: glob
boundClaims:
project_path:
- platform/*
ref_protected:
- "true"
claimMappings:
project_path: project
ref: ref
groupsClaim: groups
oidcScopes:
- profile
- email
allowedRedirectURIs:
- https://openbao.example.com/ui/vault/auth/jwt-ci/oidc/callback
callbackMode: device
pollInterval: 5
maxAge: 1h
expirationLeeway: -1
notBeforeLeeway: 2m
clockSkewLeeway: 30
oauth2Metadata:
- id_token
verboseOIDCLogging: false
tokenPoliciesTemplateClaims: false
oidcDisableConfirmation: false
tokenTTL: 10m
tokenMaxTTL: 1h
tokenExplicitMaxTTL: 2h
tokenPeriod: 0s
tokenPolicies:
- ci-deploy
policyRefs:
- name: obco-team-a-reader
tokenBoundCIDRs:
- 10.50.0.0/16
tokenNumUses: 0
tokenType: batch
tokenNoDefaultPolicy: true
tokenStrictlyBindIP: false
On GitHub: jwtauthrole.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.
| Field | Type | Required | Default | Description | Validation |
|---|---|---|---|---|---|
spec | object | yes | Desired state of a JWT/OIDC auth role, written to auth/<mountPath>/role/<name>. An oidc role needs allowedRedirectURIs; a jwt role needs at least one of boundAudiences, boundSubject, boundClaims and tokenBoundCIDRs. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: !has(self.roleType) || self.roleType != 'oidc' || has(self.allowedRedirectURIs) (allowedRedirectURIs is required for an oidc role)CEL: (has(self.roleType) && self.roleType == 'oidc') || has(self.boundAudiences) || has(self.boundSubject) || has(self.boundClaims) || has(self.tokenBoundCIDRs) (a jwt role needs at least one of boundAudiences, boundSubject, boundClaims and tokenBoundCIDRs)CEL: !has(self.tokenTTL) || !has(self.tokenMaxTTL) || duration(self.tokenTTL) <= duration(self.tokenMaxTTL) (tokenTTL must not exceed tokenMaxTTL)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.allowedRedirectURIs | []string | no | Redirect URIs accepted during the OIDC flow, for example the OpenBao UI and CLI callbacks. Required for an oidc role. Maps to `allowed_redirect_uris`. Example: [https://openbao.example.com/ui/vault/auth/oidc/oidc/callback, http://localhost:8250/oidc/callback] | Constraintsitems: >=1, <=64list type: set each item: length: <=2048 | |
spec.boundAudiences | []string | no | Values accepted in the aud claim; a login matching any of them is allowed. Maps to `bound_audiences`. Example: [openbao] | Constraintsitems: >=1, <=64list type: set each item: length: <=512 | |
spec.boundClaims | map[string][]string | no | Claims a login must carry, each mapped to its accepted values: every claim must match, and any one of its values is enough. Maps to `bound_claims`. Example: {groups: [platform-admins], project_path: [iam/*]} | Constraintsproperties: >=1, <=64 | |
spec.boundClaims.<key> | []string | no | |||
spec.boundClaimsType | string | no | "string" | How boundClaims values are matched: string (exact) or glob (* wildcards). Defaults to string. Maps to `bound_claims_type`. Example: glob | Constraintsone of:string, glob |
spec.boundSubject | string | no | Value the sub claim must equal. Unset skips the subject check. Maps to `bound_subject`. Example: system:serviceaccount:ci:runner | Constraintslength: >=1, <=512 | |
spec.callbackMode | string | no | "client" | OIDC callback flow: client (the browser redirects to the client), direct (the provider calls OpenBao) or device (device authorization flow). Defaults to client. Maps to `callback_mode`. Example: device | Constraintsone of:client, direct, device |
spec.claimMappings | map[string]string | no | Claims copied into the entity alias metadata, as claim name to metadata key. Maps to `claim_mappings`. Example: {email: email, preferred_username: username} | Constraintsproperties: <=64 | |
spec.clockSkewLeeway | int-or-string | no | Clock skew allowed on every time-based claim (iat, exp, nbf): a number of seconds, a duration such as 30s or 2m, or -1 to disable it. 0 or unset uses the OpenBao default of 60 seconds. Maps to `clock_skew_leeway`. Example: 60 | ConstraintsCEL:type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s) | |
spec.connectionRef | object | yes | Connection used to reach and log in to OpenBao. Immutable. | ||
spec.connectionRef.kind | string | no | "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.name | string | yes | Name of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao | Constraintslength: >=1, <=253 | |
spec.creationPolicy | string | no | "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.deletionPolicy | string | no | "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.driftDetection | string | no | "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.driftInterval | string | no | How 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: <=32CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s) | |
spec.expirationLeeway | int-or-string | no | Clock skew allowed when checking the exp claim: a number of seconds, a duration such as 30s or 2m, or -1 to disable the check. 0 or unset uses the OpenBao default of 150 seconds. Maps to `expiration_leeway`. Example: 30s | ConstraintsCEL:type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s) | |
spec.groupsClaim | string | no | Claim holding the group names used as external identity group aliases. Unset disables group aliases. Maps to `groups_claim`. Example: groups | Constraintslength: <=256 | |
spec.managementPolicy | string | no | "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.maxAge | string | no | Maximum time allowed since the user last authenticated with the OIDC provider, as a duration; older sessions must re-authenticate. Unset disables the check. Maps to `max_age`. Example: 1h | ||
spec.mountPath | string | no | "jwt" | Path of the JWT/OIDC auth method, without the auth/ prefix. Defaults to jwt. Immutable. Example: oidc | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: >=1, <=128 |
spec.name | string | no | Name of the role in OpenBao, used in the login request. Defaults to metadata.name. Immutable. Example: developers | Constraintspattern:^[a-z0-9_]([a-z0-9_.-]*[a-z0-9_])?$length: >=1, <=128 | |
spec.namespace | string | no | OpenBao 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.notBeforeLeeway | int-or-string | no | Clock skew allowed when checking the nbf claim: a number of seconds, a duration such as 30s or 2m, or -1 to disable the check. 0 or unset uses the OpenBao default of 150 seconds. Maps to `not_before_leeway`. Example: 30s | ConstraintsCEL:type(self) == int ? self >= -1 : self.matches('^([0-9]+(s|m|h))+$') (must be -1, a number of seconds or a duration such as 30s) | |
spec.oauth2Metadata | []string | no | OAuth2 tokens copied into the token metadata: any of access_token, id_token and refresh_token. Maps to `oauth2_metadata`. Example: [id_token] | Constraintsitems: <=3list type: set each item: one of: access_token, id_token, refresh_token | |
spec.oidcDisableConfirmation | boolean | no | When true, the OpenBao confirmation page of the OIDC flow is skipped. OpenBao only (not Vault). Defaults to false. Maps to `oidc_disable_confirmation`. Example: true | ||
spec.oidcScopes | []string | no | OIDC scopes requested in addition to openid during the OIDC flow. Maps to `oidc_scopes`. Example: [profile, email, groups] | Constraintsitems: <=64list type: set each item: length: <=256 | |
spec.policyRefs | []object | no | Policy resources in this Kubernetes namespace whose OpenBao policy names are added to tokenPolicies. The role waits until each Policy is Ready; each Policy must use the same connectionRef and namespace as the role. Example: [{name: app-read}] | Constraintsitems: <=32list type: map (keys: name) | |
spec.policyRefs[] | object | no | Reference by name to an object in the same Kubernetes namespace as this resource. | ||
spec.policyRefs[].name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.pollInterval | integer (int32) | no | Polling interval in seconds for the device and direct callback flows. Unset uses the provider's value for the device flow, otherwise 5. Maps to `poll_interval`. Example: 5 | Constraintsvalue: >=1 | |
spec.roleType | string | no | "jwt" | Login flow of the role: jwt (the client presents a JWT) or oidc (browser-based OIDC flow). Defaults to jwt. Maps to `role_type`. Example: oidc | Constraintsone of:jwt, oidc |
spec.tokenBoundCIDRs | []string | no | Client CIDR blocks or IP addresses allowed to use issued tokens. Unset allows any address. Maps to `token_bound_cidrs`. Example: [10.0.0.0/8, 192.168.1.10] | Constraintsitems: <=64list type: set CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)each item: length: <=64 | |
spec.tokenExplicitMaxTTL | string | no | Hard cap on the lifetime of issued tokens that renewals cannot extend, as a duration. Unset or 0 means no explicit cap. Maps to `token_explicit_max_ttl`. Example: 24h | ||
spec.tokenMaxTTL | string | no | Maximum lifetime of issued tokens including renewals, as a duration. Unset or 0 uses the mount or system max TTL. Maps to `token_max_ttl`. Example: 8h | ||
spec.tokenNoDefaultPolicy | boolean | no | When true, the default policy is not attached to issued tokens; only the listed policies apply. Defaults to false. Maps to `token_no_default_policy`. Example: true | ||
spec.tokenNumUses | integer (int32) | no | Maximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10 | Constraintsvalue: >=0 | |
spec.tokenPeriod | string | no | Makes issued tokens periodic: they never expire as long as they are renewed within this duration, and each renewal resets the TTL to it. Unset or 0 means not periodic. Maps to `token_period`. Example: 1h | ||
spec.tokenPolicies | []string | no | OpenBao policy names attached to issued tokens, in addition to the default policy and the policies from policyRefs. Maps to `token_policies`. Example: [app-read, app-write] | Constraintsitems: <=256list type: set each item: length: >=1, <=128 | |
spec.tokenPoliciesTemplateClaims | boolean | no | When true, tokenPolicies entries are rendered as templates over the JWT claims, for example a policy per group. Defaults to false. Maps to `token_policies_template_claims`. Example: true | ||
spec.tokenStrictlyBindIP | boolean | no | When true, issued tokens can only be used from the IP address of the client that logged in. Built-in auth methods only: an external plugin built on an older OpenBao SDK ignores it and never returns it. Defaults to false. Maps to `token_strictly_bind_ip`. Example: true | ||
spec.tokenTTL | string | no | Initial lifetime of issued tokens, as a duration. Unset or 0 uses the mount or system default TTL; must not exceed tokenMaxTTL. Maps to `token_ttl`. Example: 1h | ||
spec.tokenType | string | no | Type of token to issue. One of default (the mount's default, normally service), service (renewable, can create child tokens) or batch (lightweight, not renewable). Maps to `token_type`. Example: service | Constraintsone of:default, service, batch | |
spec.userClaim | string | yes | Claim whose value becomes the entity alias name of a login. Required. Maps to `user_claim`. Example: sub | Constraintslength: >=1, <=256 | |
spec.userClaimJSONPointer | boolean | no | When true, userClaim is read as a JSON pointer, to reach nested claims. Defaults to false. Maps to `user_claim_json_pointer`. Example: true | ||
spec.verboseOIDCLogging | boolean | no | When true, OpenBao logs received OIDC tokens and claims at debug level. May leak sensitive data; not for production. Defaults to false. Maps to `verbose_oidc_logging`. Example: false | ||
status | object | no | Observed state of the role, written by the operator. | ||
status.acquired | string | no | How the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned. | ||
status.conditions | []object | no | Current 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[] | object | no | Condition contains details for one aspect of the current state of this API Resource. | ||
status.conditions[].lastTransitionTime | string (date-time) | yes | lastTransitionTime 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[].message | string | yes | message is a human readable message indicating details about the transition. This may be an empty string. | Constraintslength: <=32768 | |
status.conditions[].observedGeneration | integer (int64) | no | observedGeneration 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[].reason | string | yes | reason 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[].status | string | yes | status of the condition, one of True, False, Unknown. | Constraintsone of:True, False, Unknown | |
status.conditions[].type | string | yes | type 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.id | string | no | Identifier 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.namespace | string | no | Absolute 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.observedGeneration | integer (int64) | no | The metadata.generation of this resource that the operator last reconciled. | ||
status.path | string | no | Full 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.rotationNonce | string | no | Value 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.serverID | string | no | Cluster 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.writeOnlyHash | string | no | Keyed 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. |