TuCloudAPI getadminuserlookups: Difference between revisions

Revision as of 04:50, 2 August 2026

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

Description

Picker for the admin-user form: the distinct roles used in this PBX (free-text datalist suggestions). No PBX picker — the section is single-PBX.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&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.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&ukey=KEY&pbx=tucall

Response

{ok, roles:[..]}.

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 ==
-Pickers for the admin-user form: distinct existing roles + the tucloud_pbx list in scope (the tucloudpbx_id picker). Authorization is enforced server-side from the ukey role: SuperRoot manages all admins (optional root filter), Operator only its own root, Client is forbidden.
+Picker for the admin-user form: the distinct roles used in this PBX (free-text datalist suggestions). No PBX picker — the section is single-PBX.
 == Call ==
@@ Line 12: / Line 12: @@
 ! Parameter !! Type !! Required !! Default !! Meaning
 |-
-| <code>root</code> || integer || No || — || SuperRoot only: restrict the pbx list to one tenant root.
+| <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.
 |}
 == Example ==
-  <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&ukey=KEY</nowiki>
+  <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&ukey=KEY&pbx=tucall</nowiki>
 == Response ==
-{ok, roles:[..], pbxs:[{_id,label,root}]}.
+{ok, roles:[..]}.
 ----
 Back to [[TuCloudAPI]]
-[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI]]
+[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]