Jump to content

TuCloudAPI authwhoami

From Wiki 7Kas

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

Description

The current session context, and it refreshes the idle timer. Needs the session cookie. {ok:false,code:no_session} when there is none, {ok:false,code:session_expired} when there was one and it aged out.

Call

https://tucloudapi.7kas.com:9087/tucloud?func=authwhoami&ukey=YOUR_KEY

GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter.

Parameters

None beyond ukey and func=authwhoami.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=authwhoami

Response

{ok, pbx, pbx_id, root, admin_ext_id, identity, is_admin, idle_timeout, identity_kind ("pbx" | "user"), login (the e-mail typed, or the sec_users login), name, priv_admin, profiles [{_id, description}], sections [nav ids the session may use; all 25 for kind pbx]}.


Back to TuCloudAPI