TuCloudAPI getadminuserlookups: Difference between revisions
TuCloudAPI reference regenerated from func=help: tenancy rule, pbx notes on every PBX-scoped function, error codes |
TuCloudAPI reference: portal users email + magic link (generated from func=help) |
||
| Line 4: | Line 4: | ||
== Description == | == Description == | ||
Picker for the | Picker for the user form: the distinct roles used in this PBX (free-text datalist suggestions), and invite:true: users are created by email invitation, with no username and no password (always true on this build). No PBX picker — the section is single-PBX. | ||
== Call == | == Call == | ||
| Line 20: | Line 20: | ||
== Response == | == Response == | ||
{ok, roles:[..]}. | {ok, roles:[..], invite:true}. | ||
== Errors == | == Errors == | ||
Latest revision as of 23:50, 3 November 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Picker for the user form: the distinct roles used in this PBX (free-text datalist suggestions), and invite:true: users are created by email invitation, with no username and no password (always true on this build). No PBX picker — the section is single-PBX.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
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. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuserlookups&ukey=KEY&pbx=tucall
Response
{ok, roles:[..], invite:true}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI