Endpoint for pending invites

Events.php

@@ -54,10 +54,10 @@ public static function onBeforeRequest($event)
             ['pattern' => 'user/group/<id:\d+>/member', 'route' => 'rest/user/group/members', 'verb' => ['GET', 'HEAD']],
             ['pattern' => 'user/group/<id:\d+>/member', 'route' => 'rest/user/group/member-add', 'verb' => ['PUT', 'PATCH']],
             ['pattern' => 'user/group/<id:\d+>/member', 'route' => 'rest/user/group/member-remove', 'verb' => ['DELETE']],
-            ['pattern' => 'user/invite', 'route' => 'rest/user/invite/index', 'verb' => 'POST'],
 
             // User: Invite Controller
-            //['pattern' => 'user/invite', 'route' => 'api/user/invite/index', 'verb' => 'POST'],
+            ['pattern' => 'user/invite', 'route' => 'rest/user/invite/index', 'verb' => 'POST'],
+            ['pattern' => 'user/invite', 'route' => 'rest/user/invite/list', 'verb' => 'GET'],
 
             // User: Session Controller
             ['pattern' => 'user/session/all/<id:\d+>', 'route' => 'rest/user/session/delete-from-user', 'verb' => 'DELETE'],

controllers/user/InviteController.php

@@ -9,16 +9,25 @@
 
 use humhub\modules\rest\components\BaseController;
 use humhub\modules\user\models\Invite;
+use humhub\modules\rest\definitions\InviteDefinitions;
 use humhub\modules\user\models\User;
 use Yii;
 use yii\validators\EmailValidator;
+use yii\helpers\ArrayHelper;
 
 
 /**
  * Class InviteController
  */
 class InviteController extends BaseController
 {
+    protected function getAccessRules()
+    {
+        return [
+            ['permissions' => [ManageUsers::class]],
+        ];
+    }
+
     public function actionIndex()
     {
         $emails = (array)Yii::$app->request->post('emails');
@@ -46,6 +55,19 @@ public function actionIndex()
         return $this->returnSuccess(count($emails) . ' users have been invited.');
     }
 
+    public function actionList()
+    {
+        $query = Invite::find()->where(['source' => Invite::SOURCE_INVITE]);
+
+        $pagination = $this->handlePagination($query, 10);
+
+        $results = ArrayHelper::getColumn($query->all(), function(Invite $invite) {
+            return InviteDefinitions::getInvite($invite);
+        });
+
+        return $this->returnPagination($query, $pagination, $results);
+    }
+
     protected function createInvite($email)
     {
         $userInvite = new Invite();

definitions/InviteDefinitions.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace humhub\modules\rest\definitions;
+
+use humhub\modules\user\models\Invite;
+
+class InviteDefinitions
+{
+    public static function getInvite(Invite $invite)
+    {
+        return [
+            'id' => $invite->id,
+            'email' => $invite->email,
+        ];
+    }
+}

docs/CHANGELOG.md

@@ -5,6 +5,7 @@ Changelog
 ------------------------
 - Enh #155: Add `requirements.php`
 - Fix #164: Disable `mustChangePassword` check for impersonated access tokens
+- Enh #170: Added new endpoint `GET /user/invite` for user pending invites
 
 0.9.3 (December 8, 2023)
 ------------------------