Jump to content

TuCloudAPI getuserprofiles

From Wiki 7Kas
Revision as of 14:31, 3 August 2026 by Maintenance script (talk | contribs) (TuCloudAPI reference: pbx param help -> FuturePBX (API surface unchanged))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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

Description

Get an admin user's profile membership + the profile picker (this PBX only). not_found if the login is not an admin user in this PBX.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getuserprofiles&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).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getuserprofiles&ukey=KEY&pbx=tucall&login=admin@x.com

Response

{ok, profile_ids:[..], profiles:[{_id,description}]}.


Back to TuCloudAPI