Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

2026-08-03T14:31:28Z

TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

← Older revision		Revision as of 14:31, 3 August 2026
Line 12:		Line 12:
	! Parameter !! Type !! Required !! Default !! Meaning		! Parameter !! Type !! Required !! Default !! Meaning
	\|-		\|-
	\| <code>pbx</code> \|\| 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.		\| <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).

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

2026-08-03T14:14:29Z

TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

← Older revision		Revision as of 14:14, 3 August 2026
Line 1:		Line 1:
	''TuCloudAPI function to manage ~~tucloud~~ (PBX) ~~services~~. Available to: '''SuperRoot, Operator, Client'''.''		''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''

	== Description ==		== Description ==

Maintenance script: API docs (generated from func=help) — add #50 security profiles/ACL

2026-08-02T05:36:46Z

API docs (generated from func=help) — add #50 security profiles/ACL

New page

''TuCloudAPI function to manage tucloud (PBX) services. 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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <code>pbx</code> || 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.
|-
| <code>group</code> || integer || Yes || — || Profile id (_id).
|-
| <code>app_name</code> || string || Yes || — || Catalog app_name (from getseclookups).
|-
| <code>access</code> || integer || No || <code>0</code> || 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).
|-
| <code>insert</code> || integer || No || <code>0</code> || 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).
|-
| <code>delete</code> || integer || No || <code>0</code> || 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).
|-
| <code>update</code> || integer || No || <code>0</code> || 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).
|-
| <code>export</code> || integer || No || <code>0</code> || 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).
|-
| <code>print</code> || integer || No || <code>0</code> || 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 ==
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=setprofileapp&ukey=KEY&pbx=tucall&group=1&app_name=grid_tucloud_pbx_ext&access=1&export=1</nowiki>

== Response ==
{ok, apps:[...]} or {ok:false,code:not_found|invalid_param}.

----
Back to [[TuCloudAPI]]
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]]

TuCloudAPI setprofileapp - Revision history

Maintenance script: TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged)

Maintenance script: TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help

Maintenance script: API docs (generated from func=help) — add #50 security profiles/ACL