TuCloudAPI updateadminuser: Difference between revisions

Revision as of 04:50, 2 August 2026

TuCloudAPI function to manage tucloud (PBX) services. 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	—	TuCloud PBX 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

@@ Line 1: / Line 1: @@
-''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator'''.''
+''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''
 == Description ==
-Edit a portal admin user. A blank/omitted password keeps the existing one; a new one is re-hashed (md5) and pswd_last_updated is bumped. root is immutable. disable_2fa=1 turns 2FA off and clears the secret (never enables — an admin can reset a locked-out user but cannot see/set the secret). tucloudpbx_id re-validated to the row's root. not_found if outside scope. Requires a non-readonly operator/superroot ukey.
+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 ==
@@ Line 11: / Line 11: @@
 {| class="wikitable sortable"
 ! Parameter !! Type !! Required !! Default !! Meaning
+|-
+| <code>pbx</code> || string || Yes || — || TuCloud PBX 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>tucloudpbx_id</code> || integer || Yes || — || Managed PBX id (must belong to the row's root).
 |-
 | <code>email</code> || string || Yes || — || Email (required, max 64, valid format).
@@ Line 33: / Line 33: @@
 |}
 == Example ==
-  <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updateadminuser&ukey=KEY&login=a@x.com&tucloudpbx_id=158&active=0</nowiki>
+  <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=updateadminuser&ukey=KEY&pbx=tucall&login=a@x.com&email=a@x.com&active=0</nowiki>
 == Response ==
@@ Line 40: / Line 40: @@
 ----
 Back to [[TuCloudAPI]]
-[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI]]
+[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]