Jump to content

TuCloudAPI getuserprofiles: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #50 security profiles/ACL
 
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help
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 ==

Revision as of 14:14, 3 August 2026

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 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.
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