TuCloudAPI setprofileapp: Difference between revisions
API docs (generated from func=help) — add #50 security profiles/ACL |
TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
== Description == | == Description == | ||
| Line 12: | Line 12: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code>pbx</code> || string || Yes || — || | | <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 profile to it. | ||
|- | |- | ||
| <code>group</code> || integer || Yes || — || Profile id (_id). | | <code>group</code> || integer || Yes || — || Profile id (_id). | ||
Latest revision as of 14:31, 3 August 2026
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
Description
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
GET https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapp&ukey=YOUR_KEY
Requires the ukey parameter.
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}.
Back to TuCloudAPI