View source for TuCloudAPI getuserprofiles

''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 <code>ukey</code> parameter.

== Parameters ==
{| class="wikitable sortable"
! Parameter !! Type !! Required !! Default !! Meaning
|-
| <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).
|}
== Example ==
 <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getuserprofiles&ukey=KEY&pbx=tucall&login=admin@x.com</nowiki>

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

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