TuCloudAPI setuserprofiles
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
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
https://tucloudapi.7kas.com:9087/tucloud?func=setuserprofiles&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. |
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}.
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