TuCloudAPI addadminuser - Revision history

Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

2026-08-03T14:30:50Z

TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

← Older revision		Revision as of 14:30, 3 August 2026
Line 12:		Line 12:
	! Parameter !! Type !! Required !! Default !! Meaning		! 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>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 (PK, email-style, max 255).		\| <code>login</code> \|\| string \|\| Yes \|\| — \|\| Admin login (PK, email-style, max 255).

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

2026-08-03T14:13:51Z

TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

← Older revision		Revision as of 14:13, 3 August 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage ~~tucloud~~ (PBX) ~~services~~. Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

	== Description ==		== Description ==

Maintenance script: API docs (generated from func=help) — #48 rescoped to per-PBX

2026-08-02T04:50:26Z

API docs (generated from func=help) — #48 rescoped to per-PBX

← Older revision		Revision as of 04:50, 2 August 2026
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 ==		== Description ==
	Create a portal admin user. login is the PK (conflict on duplicate). password is required and stored as md5(plaintext) ~~for login compatibility~~. active/priv_admin are 0/1. tucloudpbx_id ~~must belong to the effective~~ root (~~bad_pbx otherwise). SuperRoot must pass~~ root ~~(the tenant~~)~~; for an Operator~~ the ~~root is forced to its own~~. Requires a non-readonly ~~operator/superroot~~ ukey.		Create a portal admin user in THIS PBX. login is the PK (conflict on duplicate — login is globally unique). password is required and stored as md5(plaintext). email is required (max 64, valid format). active/priv_admin are 0/1. tucloudpbx_id and root are set server-side (this PBX + its root) — they are NOT accepted from the client. Requires a non-readonly ukey.

	== Call ==		== Call ==
Line 11:		Line 11:
	{\| class="wikitable sortable"		{\| class="wikitable sortable"
	! Parameter !! Type !! Required !! Default !! Meaning		! 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 (PK, email-style, max 255).		\| <code>login</code> \|\| string \|\| Yes \|\| — \|\| Admin login (PK, email-style, max 255).
	\|-		\|-
	\| <code>password</code> \|\| string \|\| Yes \|\| — \|\| Plaintext password (stored as unsalted MD5).		\| <code>password</code> \|\| string \|\| Yes \|\| — \|\| Plaintext password (stored as unsalted MD5).
	\|-
	~~\| <code>tucloudpbx_id</code> \|\| integer \|\| Yes \|\| — \|\| Managed PBX id (must belong to the effective root).~~
	\|-		\|-
	\| <code>email</code> \|\| string \|\| Yes \|\| — \|\| Email (required, max 64, valid format).		\| <code>email</code> \|\| string \|\| Yes \|\| — \|\| Email (required, max 64, valid format).
	\|-
	~~\| <code>root</code> \|\| integer \|\| No \|\| — \|\| SuperRoot only: the tenant root for the new admin (required).~~
	\|-		\|-
	\| <code>name</code> \|\| string \|\| No \|\| — \|\| Display name.		\| <code>name</code> \|\| string \|\| No \|\| — \|\| Display name.
Line 33:		Line 31:
	\|}		\|}
	== Example ==		== Example ==
	<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addadminuser&ukey=KEY&login=a@x.com&password=secret&~~tucloudpbx_id~~=~~158&root=5~~</nowiki>		<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addadminuser&ukey=KEY&pbx=tucall&login=a@x.com&password=secret&email=a@x.com</nowiki>

	== Response ==		== Response ==
Line 40:		Line 38:
	----		----
	Back to [[TuCloudAPI]]		Back to [[TuCloudAPI]]
	[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI]]		[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

Maintenance script: API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig

2026-08-02T04:37:49Z

API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig

New page

''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator'''.''

== Description ==
Create a portal admin user. login is the PK (conflict on duplicate). password is required and stored as md5(plaintext) for login compatibility. active/priv_admin are 0/1. tucloudpbx_id must belong to the effective root (bad_pbx otherwise). SuperRoot must pass root (the tenant); for an Operator the root is forced to its own. Requires a non-readonly operator/superroot ukey.

== Call ==
GET https://tucloudapi.7kas.com:9087/tucloud?func=addadminuser&ukey=YOUR_KEY
Requires the <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>login</code> || string || Yes || — || Admin login (PK, email-style, max 255).
|-
| <code>password</code> || string || Yes || — || Plaintext password (stored as unsalted MD5).
|-
| <code>tucloudpbx_id</code> || integer || Yes || — || Managed PBX id (must belong to the effective root).
|-
| <code>email</code> || string || Yes || — || Email (required, max 64, valid format).
|-
| <code>root</code> || integer || No || — || SuperRoot only: the tenant root for the new admin (required).
|-
| <code>name</code> || string || No || — || Display name.
|-
| <code>active</code> || integer || No || <code>1</code> || 1 = active, 0 = disabled.
|-
| <code>priv_admin</code> || integer || No || <code>0</code> || 1 = super-admin flag.
|-
| <code>role</code> || string || No || — || Free-text role label.
|-
| <code>phone</code> || string || No || — || Phone.
|}
== Example ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=addadminuser&ukey=KEY&login=a@x.com&password=secret&tucloudpbx_id=158&root=5</nowiki>

== Response ==
{ok, user:{...}} or {ok:false,code:conflict|invalid_param}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI]]