TuCloudAPI setprofileapp
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: Set ONE app's permissions for a profile. 0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). bad_app if app_name is not in the catalog. not_found if the profile is not in this PBX. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapp&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). |
app_name |
string | Yes | — | Catalog app_name (from getseclookups). |
access |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
insert |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
delete |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
update |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
export |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
print |
integer | No | 0 |
0/1. Only privileges meaningful for the app's app_type are stored; the rest are forced to 0 server-side (form=all; cons=access/export/print; calendar=access/insert/delete/update; other=access only). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapp&ukey=KEY&pbx=tucall&group=1&app_name=grid_tucloud_pbx_ext&access=1&export=1
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