pbs_tfa_unlock
Clear a user's TOTP lockout caused by multiple failed attempts. Dry-run preview by default; set confirm=True to execute the unlock.
Instructions
MUTATION (HIGH): clear a user's TOTP lockout (PUT /access/users/{userid}/unlock-tfa — note the path lives under /access/users/, not /access/tfa/{userid}/). HIGH because it removes the anti-brute-force throttle guarding a 6-digit TOTP keyspace — an account-takeover enabler if the lockout was triggered by a real guessing attack. Dry-run by default. confirm=True executes and returns a dict whose result is a bool: whether the user was previously locked out. Synchronous. Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| userid | Yes | PBS user id to clear a TOTP lockout for, format 'user@realm'. | |
| confirm | No | False (default) returns a dry-run PLAN preview; True executes the mutation. | |
| 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 |