TuCloudAPI setprofileapps
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
RETIRED 2026-10-31 (operator: the legacy matrix is never altered again). Always answers {ok:false, code:retired}; use setprofilesections. Former behaviour: Bulk-save a profile's FULL permission matrix in one call (the primary matrix write). matrix = a JSON array of {app_name, access, insert, delete, update, export, print} (flags 0/1) that MUST cover every catalog app — an incomplete or empty matrix is rejected (invalid_param), so a partial body can never leave stale permissions; extra unknown app_names are ignored. app_type-irrelevant privileges are normalised to 0 server-side. Send via POST body. not_found if the profile is not in this PBX. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapps&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 profile to it. |
group |
integer | Yes | — | Profile id (_id). |
matrix |
string | Yes | — | JSON array of per-app permission rows (see description). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapps&ukey=KEY&pbx=tucall&group=1 (matrix in POST body)
Response
{ok, apps:[...]} or {ok:false,code:not_found|invalid_param}.
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