TuCloudAPI getadminuser: Difference between revisions
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <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 (_id, email-style). | | <code>login</code> || string || Yes || — || Admin login (_id, email-style). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Get one portal admin user by login (_id) within this PBX. not_found if the login is not in this PBX. google2fa_enabled is status only; the secret is never exposed.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&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. |
login |
string | Yes | — | Admin login (_id, email-style). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&pbx=tucall&login=admin@x.com
Response
{ok, user:{_id,login,name,email,active,priv_admin,role,phone,tucloudpbx_id,root,google2fa_enabled}}.
Back to TuCloudAPI