Jump to content

TuCloudAPI getadminusers

From Wiki 7Kas

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

List this PBX's portal admin users (tucloud_sec_users). Strictly scoped to the (ukey, pbx) PBX. Passwords / 2FA secrets are never returned.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getadminusers&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.
q string No Optional search over login/name/email (contains).

Example

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

Response

{ok, rows:[{_id,login,name,email,active,priv_admin,role,tucloudpbx_id,root}]}.


Back to TuCloudAPI