TuCloudAPI updateadminuser
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Edit a portal user in THIS PBX: name, active, priv_admin, role and phone are replaced as sent; disable_2fa=1 turns 2FA off and clears the secret (never enables). The password and the email are never changed here: a non-empty password is refused (field password, reason not_allowed); an email that is absent, empty, the confirmed address or the open one is ignored (a form re-posting the record never fails and never mails), a DIFFERENT one is refused (field email, reason not_allowed): the email changes with requestadminuseremail. A refusal writes nothing. tucloudpbx_id and root are NEVER changed. not_found if the login is not in this PBX. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=updateadminuser&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
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 | — | The user's _id (login). A new user's is generated by the server and never shown. |
email |
string | No | — | Ignored when absent, empty, the current or the open address; any other value is refused. |
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=u0123456789abcdef&name=Ana&active=1
Response
{ok, user:{...}, status, email_pending, expires_in} | {ok:false, code, field?, reason?, message}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI