pbs_realm_openid_update
Update an OpenID realm configuration on Proxmox Backup Server. Dry-run by default returns a plan preview; set confirm=True to apply changes.
Instructions
MUTATION (MEDIUM): update an OpenID realm's config. Dry-run by default — the PLAN reads
the realm's current config first. client_key, if supplied, is redacted identically to
pbs_realm_openid_create's. confirm=True executes and returns a dict; synchronous, no UPID.
NOTE: there is NO username_claim parameter here — the live PBS schema makes it create-only (set it at pbs_realm_openid_create time); PUT is additionalProperties:false, so accepting it here would only hard-fail the whole update server-side. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| realm | Yes | OpenID realm name to update. | |
| digest | No | Optional SHA256 config digest to prevent concurrent modifications. | |
| prompt | No | OpenID prompt parameter; omit to leave unchanged. | |
| scopes | No | OpenID scope list, SPACE-separated; omit to leave unchanged. | |
| comment | No | Optional free-text comment; omit to leave unchanged. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| default | No | Default-realm-on-login flag; omit to leave unchanged. | |
| audiences | No | OpenID audience list string; omit to leave unchanged. | |
| client_id | No | OpenID client id; omit to leave unchanged. | |
| acr_values | No | OpenID ACR list string; omit to leave unchanged. | |
| autocreate | No | Autocreate-on-login flag; omit to leave unchanged. | |
| client_key | No | New OpenID client secret; redacted from all plans/logs/ledger. | |
| issuer_url | No | OpenID issuer URL; omit to leave unchanged. | |
| delete_props | No | Property names to clear. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |