TuCloudAPI setuserprofiles: Difference between revisions

Latest revision as of 14:31, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

Full-replace an admin user's profile membership (this PBX only). profile_ids = a comma-separated list of profile ids (empty = remove all). Every id must be a profile in this PBX (bad_profile otherwise). not_found if the login is not an admin user in this PBX. Requires a non-readonly ukey.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=setuserprofiles&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.
`login`	string	Yes	—	Admin user login (_id from #48).
`profile_ids`	string	No	—	Comma-separated profile ids (empty = clear all).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=setuserprofiles&ukey=KEY&pbx=tucall&login=admin@x.com&profile_ids=1,3

Response

{ok, profile_ids:[..]} or {ok:false,code:not_found|invalid_param}.

Back to TuCloudAPI

@@ Line 12: / Line 12: @@
 ! 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>login</code> || string || Yes || — || Admin user login (_id from #48).