TuCloudAPI deleteadminuser: 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 == | ||
Delete a portal | Delete a portal user by login within this PBX; their open email change is cancelled with them. not_found if the login is not in this PBX. Requires a non-readonly ukey. | ||
== Call == | == Call == | ||
| Line 16: | Line 16: | ||
| <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>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 || — || | | <code>login</code> || string || Yes || — || The user's _id (login). A new user's is generated by the server and never shown. | ||
|} | |} | ||
== Example == | == Example == | ||
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=deleteadminuser&ukey=KEY&pbx=tucall&login= | <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=deleteadminuser&ukey=KEY&pbx=tucall&login=u0123456789abcdef</nowiki> | ||
== Response == | == Response == | ||
Latest revision as of 23:50, 3 November 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
ℹ Requires the
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
Delete a portal user by login within this PBX; their open email change is cancelled with them. not_found if the login is not in this PBX. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=deleteadminuser&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. |
login |
string | Yes | — | The user's _id (login). A new user's is generated by the server and never shown. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=deleteadminuser&ukey=KEY&pbx=tucall&login=u0123456789abcdef
Response
{ok, _id} or {ok:false,code:not_found}.
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