added list_usergroups to API class and to API browser

version 1.0.1
ThreepE0 · Mar 23, 2016 · 09607db · 09607db
1 parent bdf4d69
commit 09607db
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/index.php b/index.php
@@ -14,7 +14,7 @@
   Ubiquiti Community forums for this:
   https://community.ubnt.com/t5/UniFi-Wireless/Unifi-API-browser-tool-released/m-p/1392651
 
-VERSION: 1.0
+VERSION: 1.0.1
 
 ------------------------------------------------------------------------------------
 
@@ -228,6 +228,10 @@
         $selection  = 'list guests';
         $data       = $unifidata->list_guests();
         break;
+    case 'list_usergroups':
+        $selection  = 'list usergroups';
+        $data       = $unifidata->list_usergroups();
+        break;
     case 'stat_hourly_site':
         $selection  = 'hourly site stats';
         $data       = $unifidata->stat_hourly_site();
@@ -477,6 +481,7 @@ function to print the output
               <li id="list_clients"><a href="?action=list_clients">list online clients</a></li>
               <li id="list_guests"><a href="?action=list_guests">list guests</a></li>
               <li id="list_users"><a href="?action=list_users">list users</a></li>
+              <li id="list_usergroups"><a href="?action=list_usergroups">list user groups</a></li>
               <li role="separator" class="divider"></li>
               <li id="stat_allusers"><a href="?action=stat_allusers">stat all users</a></li>
               <li id="stat_auths"><a href="?action=stat_auths">stat authorisations</a></li>

diff --git a/phpapi/class.unifi.php b/phpapi/class.unifi.php
@@ -9,7 +9,7 @@
   and the API as published by Ubiquiti:
     https://dl.ubnt.com/unifi/4.7.6/unifi_sh_api
 
-VERSION: 1.0
+VERSION: 1.0.1
 
 NOTE:
 this Class will only work with Unifi Controller versions 4.x. There are no checks to prevent you from
@@ -435,6 +435,27 @@ public function list_clients() {
       return $return;
    }
 
+   /*
+   list user groups
+   returns an array of user group objects
+   */
+   public function list_usergroups() {
+      if (!$this->is_loggedin) return false;
+      $return           = array();
+      $json             = json_encode(array());
+      $content_decoded  = json_decode($this->exec_curl($this->baseurl.'/api/s/'.$this->site.'/list/usergroup','json='.$json));
+      if (isset($content_decoded->meta->rc)) {
+         if ($content_decoded->meta->rc == 'ok') {
+            if (is_array($content_decoded->data)) {
+               foreach ($content_decoded->data as $usergroup) {
+                  $return[]= $usergroup;
+               }
+            }
+         }
+      }
+      return $return;
+   }
+
    /*
    list health metrics
    returns an array of health metric objects