TuCloudAPI updateadminuser: Difference between revisions
Appearance
API docs (generated from func=help) — #48 rescoped to per-PBX |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <code>pbx</code> || string || Yes || — || FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX and scopes every admin user to it. | ||
|- | |- | ||
| <code>login</code> || string || Yes || — || Admin login (_id). | | <code>login</code> || string || Yes || — || Admin login (_id). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Edit a portal admin user in THIS PBX. A blank/omitted password keeps the existing one; a new one is re-hashed (md5) and pswd_last_updated is bumped. email required. tucloudpbx_id and root are NEVER changed (the user cannot be moved to another PBX/root). disable_2fa=1 turns 2FA off and clears the secret (never enables). not_found if the login is not in this PBX. Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=updateadminuser&ukey=YOUR_KEY
Requires the ukey parameter.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX and scopes every admin user to it. |
login |
string | Yes | — | Admin login (_id). |
email |
string | Yes | — | Email (required, max 64, valid format). |
password |
string | No | — | New plaintext password (blank = keep existing). |
name |
string | No | — | Display name. |
active |
integer | No | 1 |
1 = active, 0 = disabled. |
priv_admin |
integer | No | 0 |
1 = super-admin flag. |
role |
string | No | — | Free-text role label. |
phone |
string | No | — | Phone. |
disable_2fa |
integer | No | 0 |
1 = disable 2FA and clear the secret (reset). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=updateadminuser&ukey=KEY&pbx=tucall&login=a@x.com&email=a@x.com&active=0
Response
{ok, user:{...}} or {ok:false,code:not_found|invalid_param}.
Back to TuCloudAPI