TuCloudAPI getadminuser: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
API docs (generated from func=help) — #48 rescoped to per-PBX |
||
| 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 == | ||
Get one portal admin user by login (_id). not_found if | 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 == | == 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 (_id, email-style). | | <code>login</code> || string || Yes || — || Admin login (_id, email-style). | ||
|} | |} | ||
== Example == | == Example == | ||
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&login=admin@x.com</nowiki> | <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&pbx=tucall&login=admin@x.com</nowiki> | ||
== Response == | == Response == | ||
| Line 22: | Line 24: | ||
---- | ---- | ||
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]] | ||
Revision as of 04:50, 2 August 2026
TuCloudAPI function to manage tucloud (PBX) services. 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 | — | 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. |
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