TuCloudAPI getadminuser: Difference between revisions
API docs (generated from func=help) — add #48 adminusers + #52 pbxconfig |
TuCloudAPI reference: portal users email + magic link (generated from func=help) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''TuCloudAPI function to manage | ''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.'' | ||
{{Note|1=Requires the <code>pbx</code> parameter (the PBX '''name''', e.g. <code>tucall</code>). The server verifies that your <code>ukey</code>'s own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns <code>{"ok":false,"code":"forbidden"}</code>.}} | |||
== Description == | == Description == | ||
Get one portal | Get one portal user by login (_id) within this PBX. not_found if the login is not in this PBX. user carries status (invited: no confirmed email yet, cannot log in | active), email_pending (the address of the open change: pending, or expired until resent or cancelled; "" when none) and expires_in (seconds left on its link; 0 when none or expired), repeated flat. google2fa_enabled is status only; the secret is never exposed. | ||
== Call == | == Call == | ||
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=YOUR_KEY&pbx=PBX_NAME | |||
Requires the <code>ukey</code> parameter. | GET, or POST with the parameters form-urlencoded in the body. Requires the <code>ukey</code> parameter. Always HTTP 200; the response is a JSON envelope. | ||
== Parameters == | == Parameters == | ||
| Line 12: | Line 14: | ||
! Parameter !! Type !! Required !! Default !! Meaning | ! Parameter !! Type !! Required !! Default !! Meaning | ||
|- | |- | ||
| <code> | | <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 admin user to it. | ||
|- | |||
| <code>login</code> || string || Yes || — || The user's _id (login). A new user's is generated by the server and never shown. | |||
|} | |} | ||
== Example == | == Example == | ||
<nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&login= | <nowiki>https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&pbx=tucall&login=u0123456789abcdef</nowiki> | ||
== Response == | == Response == | ||
{ok, user:{_id,login,name,email,active,priv_admin,role,phone,tucloudpbx_id,root,google2fa_enabled}}. | {ok, user:{_id,login,name,email,active,priv_admin,role,phone,tucloudpbx_id,root,google2fa_enabled,status,email_pending,expires_in}, status, email_pending, expires_in}. | ||
== Errors == | |||
Always HTTP 200. On failure the body is <code>{"ok":false,"code":"...","message":"..."}</code>. Common codes: <code>missing_pbx</code>, <code>forbidden</code>, <code>invalid_param</code>, <code>not_found</code>, <code>conflict</code>, <code>in_use</code>, <code>db_error</code>, <code>server_busy</code>; the Response section above lists any specific to this function. | |||
---- | ---- | ||
Back to [[TuCloudAPI]] | Back to [[TuCloudAPI]] | ||
[[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI]] | [[Category:TuCloudAPI SuperRoot]][[Category:TuCloudAPI Operator]][[Category:TuCloudAPI Client]][[Category:TuCloudAPI]] | ||
Latest revision as of 23:50, 3 November 2026
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
Get one portal user by login (_id) within this PBX. not_found if the login is not in this PBX. user carries status (invited: no confirmed email yet, cannot log in | active), email_pending (the address of the open change: pending, or expired until resent or cancelled; "" when none) and expires_in (seconds left on its link; 0 when none or expired), repeated flat. google2fa_enabled is status only; the secret is never exposed.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&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 admin user to it. |
login |
string | Yes | — | The user's _id (login). A new user's is generated by the server and never shown. |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=getadminuser&ukey=KEY&pbx=tucall&login=u0123456789abcdef
Response
{ok, user:{_id,login,name,email,active,priv_admin,role,phone,tucloudpbx_id,root,google2fa_enabled,status,email_pending,expires_in}, status, email_pending, expires_in}.
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