TuCloudAPI deleteprofile: Difference between revisions
API docs (generated from func=help) — add #50 security profiles/ACL |
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help |
||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
Revision as of 14:14, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
Delete a profile. Blocked {ok:false,in_use,member_count} when it still has members, unless force=1 (then the DB cascades the app matrix + memberships). not_found if not in this PBX. Requires a non-readonly ukey.
Call
GET https://tucloudapi.7kas.com:9087/tucloud?func=deleteprofile&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 profile to it. |
group |
integer | Yes | — | Profile id (_id). |
force |
integer | No | 0 |
1 = delete even if it has members (cascades memberships). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=deleteprofile&ukey=KEY&pbx=tucall&group=1
Response
{ok, _id} or {ok:false,code:in_use,member_count} or {ok:false,code:not_found}.
Back to TuCloudAPI