Skip to content

IAMClient API

Group iam.rbc.example
Version v1alpha1
Kind IAMClient
Scope Namespaced
Short name iamc
Printer columns AppID, Ready, SecretExpires

The tables below are generated from deploy/crd.yaml when the docs are built.

Spec

Field Type Required Default Description
deletionPolicy Retain | Delete "Retain" What happens in Entra when this IAMClient is deleted. Retain (default) revokes the client secrets but keeps the registration for audit and recovery; Delete removes it (Entra soft-deletes for 30 days).
dex object (optional) Optional Dex front door for this client.
dex.issuerURL string yes Issuer URL of the team's Dex, e.g. https://dex.team-payments.apps.example.com. Entra gets <issuerURL>/callback as its only redirect URI.
displayName string yes Human-readable name. Admin-only. The controller prefixes it with the platform naming prefix.
groups []string [] Entra groups the app cares about. Emitted as the Dex connector groups filter, and switches Entra group claims to ApplicationGroup.
owners []string [] Entra object IDs of human owners to add to the registration.
pushSecret object (optional) Optional: also push the delivered Secret to OpenBao through an External Secrets Operator PushSecret. Admin-only. The Kubernetes Secret is always written; the PushSecret reads from it. The OpenBao path is fixed by the controller (<prefix><namespace>/<name>), not by the team.
pushSecret.clusterSecretStore string (optional) ClusterSecretStore to push to. Must be on the controller's allow-list; omitted means the controller's default store. Namespaced SecretStores are not accepted: the team could repoint one.
redirectURIs []string [] Redirect URIs of the team's application. Owner-editable. With dex set, these become Dex static-client redirect URIs and Entra only ever sees Dex's own callback. Without dex, they go straight onto the Entra app.
secretRotation string "90d" How long each client secret lives, e.g. 90d or 720h. Rotation starts when a third of the lifetime remains.

Who may change what

Field Editable by Change needs
redirectURIs Owning team or admin Nothing beyond the redirect policy
Every other field Platform admin only A new iam.rbc.example/change-ref

See approvals and change kinds.

Field notes

displayName
Shown to users on sign-in and consent screens, prefixed with NAME_PREFIX (default charter-).
redirectURIs
HTTPS only, no wildcards, host under an allowed domain. Order does not matter. With dex set they configure the Dex static client instead of Entra.
groups
Group names passed to Dex as a filter. Any non-empty list also sets the Entra app's groupMembershipClaims to ApplicationGroup. Charter does not assign the groups to the app.
secretRotation
A number and a unit: d (days), h (hours) or m (minutes). Between 1h and 730d, and not above the controller's MAX_SECRET_LIFETIME_DAYS.
owners
Entra object IDs (not UPNs) of users accountable for the registration. At least one is required.
deletionPolicy
Retain revokes all secrets and keeps the registration; Delete deletes it (soft-deleted for 30 days). See deleting a client.
dex
See Dex in front of Entra.
pushSecret
See delivering to OpenBao. {} uses the controller's default store.

Status

Field Type Required Default Description
appId string (optional) Application (client) ID of the Entra app registration.
appliedAdminHash string (optional) Hash of the admin-only fields last applied; a mismatch needs a new approval.
appliedSpecHash string (optional) Evidence of the approval the last applied spec was reconciled under.
approvedBy string (optional) Approver recorded when the current admin-only state was applied.
changeRef string (optional) Change reference the current admin-only state was applied under.
conditions []object [] Ready, plus SecretPushed when spec.pushSecret is set.
conditions[].lastTransitionTime string yes RFC 3339 time the condition last changed status.
conditions[].message string yes Human-readable detail, truncated to 1000 characters.
conditions[].observedGeneration integer (optional) metadata.generation the condition was computed from.
conditions[].reason string yes Machine-readable reason, e.g. Reconciled, PendingApproval, PolicyViolation.
conditions[].status string yes True or False.
conditions[].type string yes Ready or SecretPushed.
objectId string (optional) Directory object ID of the app registration.
observedGeneration integer (optional) metadata.generation this status was computed from.
pushSecretName string (optional) PushSecret that copies secretName to OpenBao, when spec.pushSecret is set.
pushedTo string (optional) <clusterSecretStore>:<remoteKey> the credentials are pushed to.
secretExpiresAt string (optional) RFC 3339 expiry of the current client secret.
secretKeyId string (optional) keyId of the client secret currently delivered.
secretName string (optional) Kubernetes Secret holding the credentials and Dex config.
servicePrincipalId string (optional) Object ID of the service principal in the tenant.

See status and conditions for how to read these.

Full example

# Copyright (c) 2026 Erick Bourgeois, charter
# SPDX-License-Identifier: Apache-2.0

# What Flux renders from the ResourceSet (see flux/resourceset.yaml), after
# the owning team has added redirect URIs with `kubectl edit`.
apiVersion: iam.rbc.example/v1alpha1
kind: IAMClient
metadata:
  name: payments-portal
  namespace: team-payments
  annotations:
    iam.rbc.example/requested-by: "alice@example.com"   # admin-only
    iam.rbc.example/approved-by: "bob@example.com"      # admin-only
    iam.rbc.example/change-ref: "CHG0012345"            # admin-only
    # iam.rbc.example/last-modified-by is stamped by admission, never set by hand
spec:
  displayName: Payments Portal                          # admin-only
  redirectURIs:                                         # owner-editable
    - https://payments.apps.example.rbc.com/callback
  groups: ["APP-Payments-Users", "APP-Payments-Admins"] # admin-only
  secretRotation: 90d                                   # admin-only
  owners:                                               # admin-only
    - 11111111-1111-1111-1111-111111111111
  deletionPolicy: Retain                                # admin-only
  dex:                                                  # admin-only
    issuerURL: https://dex.team-payments.apps.example.rbc.com
  pushSecret:                                           # admin-only, optional
    clusterSecretStore: openbao                         # -> OpenBao charter/team-payments/payments-portal