TuCloudAPI getadminuser
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