Coyo - Administration Guide Version: 13 2015-11-03
Table of Contents 1 Einstellungen 3 1.1 Allgemein 4 1.1.1 Applikationsname 4 1.1.2 Standard Zeitzone 4 1.1.3 Standard Sprache 4 1.1.4 Benutzer folgen sich automatisch 5 1.1.5 Embeddables Einstellungen 5 1.1.6 Download Link anzeigen 5 1.1.7 Push-Benachrichtigungen 6 1.1.8 Zeige Mobil Link 7 1.1.9 Statistiken / Tracking 8 1.1.10 Hilfetext 8 1.1.11 Tracking Code 9 1.1.12 Workspaces 9 1.1.13 Externe Nutzer 10 1.1.14 Authentifizierung & Registrierung 10 1.1.15 Neue Benutzer automatisch aktivieren 10 1.1.16 Domainbeschränkung der Registrierung 11 1.1.17 Authentifizierungs-Methoden 11 1.1.18 Private Nachrichten & Chat 12 1.2 Apps 13 1.3 Plugins 14 1.4 Suche 15 1.5 Lizenz 16 1.6 Hashtags 17 1.7 Logs 17 2 Benutzerverwaltung 19 2.1 Benutzer verwalten 20 2.2 Benutzer erstellen 22 2.3 Rollen verwalten 23
2.4 Rollen erstellen 24 2.5 Gruppen 26 3 Lesezeichen 28 3.1 Private Lesezeichen 29 4 Design 30 5 Kategorien 32 6 Teaser 34 7 Statistiken 37 8 REST API 39 8.1 Authentifizierung via REST API 40 8.1.1 Authentifizierung via session 40 8.1.2 Authentifizierung mit Benutzeranmeldedaten 40 8.1.3 Authentifizierung mit Token 41 8.2 API methoden 41 8.2.1 Public API 41 8.2.2 ActivityStream API 41 8.2.3 Messaging API 42 8.2.4 Wall API 44 8.2.5 User API 44 8.2.6 Notifications API 46 9 Superadmin Modus 47
1 Einstellungen 1.1 Allgemein 1.1.1 Applikationsname "Einstellungen -> Allgemein" Der Name Ihrer Applikation erscheint beispielsweise im Tab Ihres Browsers, oder in den Email-Benachrichtigungen. Zur Identifizierung sollte sich der Name auf das Unternehmen beziehen. 1.1.2 Standard Zeitzone "Einstellungen -> Allgemein" Die Standard Zeitzone sollte festgelegt werden, bevor Sie weitere Nutzer auf Ihre Plattform einladen. Diese Zeitzone wird dann für alle neuen Nutzer automatisch festgelegt. Danach kann jeder Nutzer in seinen Profil-Einstellungen seine persönliche Zeitzone festlegen. 1.1.3 Standard Sprache "Einstellungen -> Allgemein" Die Standard Sprache sollte festgelegt werden, bevor Sie neue Nutzer auf Ihre Plattform einladen. Für alle neuen Nutzer ist dann diese Sprache als Standard Sprache festgelegt. Danach kann jeder Nutzer in seinen Profil-Einstellungen individuell die Sprache der Oberfläche auswählen. 4
1.1.4 Benutzer folgen sich automatisch "Einstellungen -> Allgemein" Generell sollen Nutzer Kollegen auswählen, denen Sie folgen möchten. Dieses Prinzip ist sinnvoll für größere Unternehmen, damit Nutzer nur die Informationen erhalten, die für sie relevant sind. So wird verhindert, dass Nutzer zu viele für sie irrelevante Informationen erhalten. In kleineren Unternehmen ist es sinnvoll, dass Nutzer sich automatisch folgen, und diese Funktion zu aktivieren. 1.1.5 Embeddables Einstellungen "Einstellungen -> Allgemein" Embeddables ermöglichen Ihnen, gewisse Komponenten Ihrer Applikation auf externen Webseiten zu benutzen. Zum Beispiel besteht die Möglichkeit einen Gefällt mir Button, oder ein Kommentar-Feld, in eine externe Webseite zu integrieren. Genauere Informationen über die Implementierung der Embeddables finden Sie im Hauptartikel Embeddables. 1.1.6 Download Link anzeigen Hier können Sie festlegen, ob der Download-Bereich in den Einstellungen sichtbar ist oder nicht. 5
Das Listenobjekt " Downloads" bei aktivierter Einstellung: 1.1.7 Push-Benachrichtigungen "Einstellungen -> Allgemein" Mit der Version 3.3 wurden Push-Benachrichtigungen eingeführt, die sie hier aktivieren können. 6
Ein weiterer Schritt wäre das Aus- und wieder Einloggen in die App auf Ihrem mobilen Endgerät. Mit diesem Vorgang registrieren Sie Ihr Gerät für die Push-Benachrichtigungen. Um zu prüfen, ob Ihr Gerät registriert ist, schauen Sie in Ihren Einstellungen unter Push-Geräte nach. Die letzte Voraussetzung gilt nur für unsere Enterprise Kunden. Nutzen Sie die Enterprise Version auf Ihrem eigenen Servern, muss Ihr Server, auf dem die Applikation läuft, Zugriff auf den Push-Benachrichtigungs-Server haben (psn.mindsmash.com). 1.1.8 Zeige Mobil Link "Einstellungen -> Allgemein" Ist diese Option aktiviert, wird ein Link mit Informationen über den mobilen Zugriff im Dropdown der Navigationsleiste angezeigt. 7
1.1.9 Statistiken / Tracking "Einstellungen -> Allgemein" Hier können Sie das Tracking von Aktivitäten und die Statistiken aktivieren. 1.1.10 Hilfetext "Einstellungen -> Allgemein" 8
Hier können Sie einen individuellen Hilfetext einfügen. Sollte dieses Feld leer bleiben, führt der Hilfe-Button zum Support-Center. 1.1.11 Tracking Code "Einstellungen -> Allgemein" Das Tracking Code Feld ermöglicht dem Administrator Tracking Codes von Dritten, wie zum Beispiel Google Analytics, einzufügen. 1.1.12 Workspaces "Einstellungen -> Allgemein -> Workspaces" Diese Option ermöglicht dem Administrator Workspaces zu aktivieren und deaktivieren. 9
1.1.13 Externe Nutzer Sie haben die Möglichkeit externe Nutzer auf Ihre Plattform einzuladen. Hierfür müssen Sie von einem Admin Ihres Systems berechtigt werden. Diese Option finden Sie in der Benutzerverwaltung unter Rollen. 1.1.14 Authentifizierung & Registrierung "Einstellungen -> Allgemein -> Authentifizierung & Registrierung" Diese Option ermöglicht es Nutzern sich auf Ihrer Plattform zu registrieren. Auf der Startseite Ihrer Instanz erscheint nun ein "Account erstellen" Link. Der neue Nutzer bekommt eine Verifizierungs-Mail, um seine Email-Adresse, und damit seinen Account, zu bestätigen. Nach dem Bestätigen des Links, erhält der Superadmin der Instanz eine Benachrichtigung über den neuen Nutzer. 1.1.15 Neue Benutzer automatisch aktivieren "Einstellungen -> Allgemein -> Authentifizierung & Registrierung" Diese Funktion ermöglicht es neue Nutzer automatisch zu aktivieren. Ist diese Funktion deaktiviert, muss der Administrator neue Nutzer manuell über die Benutzerverwaltung aktivieren. 10
1.1.16 Domainbeschränkung der Registrierung "Einstellungen -> Allgemein -> Authentifizierung & Registrierung" Die Domainbeschränkung der Registrierung ermöglicht dem Administrator nur ausgewählte Domains für die Registrierung zuzulassen, beispielsweise die Domain-Endung des Unternehmens. Email-Adressen, die nicht mit dieser Domain übereinstimmen, können sich nicht auf der Plattform registrieren. Um alle Domains zuzulassen, lassen Sie dieses Feld leer. 1.1.17 Authentifizierungs-Methoden "Einstellungen -> Allgemein -> Authentifizierung & Registrierung" Die Applikation bringt mehrere Authentifizierungs-Methoden mit sich, wie zum Beispiel OpenID, Twitter oder Facebook Authentifizierung. 11
1.1.18 Private Nachrichten & Chat "Einstellungen -> Allgemein -> Private Nachrichten, Chat & Anrufe" Das private Nachrichtensystem ermöglicht es Ihnen ihren Kollegen private Nachrichten zu schreiben. Es ist ein asynchrones Nachrichtensystem, was bedeutet, dass Sie einem Kollegen eine Nachricht schicken können, auch wenn dieser nicht online ist. Der Live-Chat dient zur Kommunikation zweier sich online befindenden Nutzern. Um diese zu ermöglichen, müssen Sie den Live-Chat aktivieren. 12
1.2 Apps "Einstellungen -> Apps" In den App Einstellungen kann der Administrator festlegen, welche Apps aktiviert oder deaktiviert sind. Deaktivierte Apps stehen beim Erstellen einer neuen App in einem Workspace oder einer Seite nicht zur Verfügung. 13
1.3 Plugins "Einstellungen -> Plugins" In den Plugin Einstellungen kann festgelegt werden, welche Plugins angezeigt, bzw. aktiv sind. Diese können je nach Bedarf des Unternehmens angepasst werden. Um die Reihenfolge der Plugins zu verändern, können Sie diese per Drag & Drop neu anordnen. 14
1.4 Suche "Einstellungen -> Suche" In seltenen Fällen kann es dazu kommen, dass der Suchindex zurückgesetzt werden muss. Sollten Sie den Suchindex zurücksetzen, stellen Sie vorher sicher, dass niemand in das System eingeloggt ist. Je nach Größe der Datenbank und der im System gespeicherten Daten, kann das Zurücksetzen der Datenbank ein paar Minuten in Anspruch nehmen. 15
1.5 Lizenz "Einstellungen -> Server - Info und Lizenz" Die Server Info zeigt die Informationen Ihres Servers und Ihrer Applikation an. Außerdem wird die Server ID angezeigt, welche nötig ist um eine gültige Lizenz zu generieren. Die Lizenz zeigt die Informationen Ihres individuellen Lizenz-Schlüssels an. Sollten Sie eine Benachrichtigung über einen ungültigen Lizenzschlüssel erhalten, könnte dies an einer überschrittenen Nutzerzahl liegen. 16
Sollten Sie in die Situation kommen, eine neue Server ID generieren zu müssen, können Sie dies durch den unten aufgelisteten Button realisieren. 1.6 Hashtags "Einstellungen -> Hashtags" In den Hashtag Einstellungen haben Sie die Möglichkeit, Hashtags zu einer Sperrliste hinzuzufügen. Hier können Sie einen Hashtag der Sperrliste hinzufügen 1.7 Logs "Einstellungen -> Logs" 17
Eine Liste aller verfügbarer Logdateien: Um die Logdatei näher zu betrachten, reicht ein Klick auf die betreffende Datei: Sie können die Logdatei über den Button "Download" Herunterladen. 18
Logdateien sind für unser Support-Team sehr wichtig um eventuell auftretende Fehler nachvollziehen zu können. 19
2 Benutzerverwaltung "Benutzerverwaltung" 2.1 Benutzer verwalten "Benutzerverwaltung -> Benutzer" Das unten aufgeführte Beispiel zeigt den Benutzer Robert, Robert kann durch einen klick auf das Zahnrad auf der rechten Seite verwaltet werden. Folgende Optionen stehen zur Verfügung: 20
Administratoren können folgende Attribute eines Benutzers verwalten: 21
2.2 Benutzer erstellen "Benutzerverwaltung -> Benutzer" Um einen neuen Benutzer zu erstellen, klicken Sie auf den Button " Benutzer erstellen" " Alle Passwörter zurücksetzen" setzt Systemweit alle Passwörter zurück und benachrichtigt die Anwender per Email. "Gelöschte anzeigen" zeigt alle gelöschten Accounts an. Zur Benutzererstellung fehlen wenige erforderliche Informationen: 22
Wenn der Haken bei " Aktiv" nicht gesetzt ist, wird der Benutzer im System hinterlegt, kann sich jedoch nicht anmelden. 2.3 Rollen verwalten "Benutzerverwaltung -> Rollen" 23
Um Benutzern eine Rolle zuzuweisen, klicken Sie auf das Zahnrad der betreffenden Rolle und wählen "Benutzer verwalten" Um Rollen zu erstellen, lesen Sie den Punkt "Rollen erstellen" 2.4 Rollen erstellen "Benutzerverwaltung -> Rollen" Um eine Rolle zu erstellen, klicken Sie auf den Button "Rolle erstellen" Benennen Sie die Rolle: 24
Info: Manchmal kann es sinnvoll sein, neuen Benutzern automatisch eine Rolle zuzuweisen: Vergeben Sie spezifische Berechtigungen: 25
2.5 Gruppen "Benutzerverwaltung -> Gruppen" 26
Benutzergruppen können Sie im Administrationsbereich erstellen. In größeren Unternehmen macht es Sinn Gruppen zu erstellen, beispielsweise für Abteilungen. Um eine Gruppe zu erstellen, klicken Sie den Gruppe erstellen Button. Nun können Sie Ihre Gruppe benennen, die Gruppe als Standardgruppe für neue Nutzer festlegen, und der Gruppe eine Rolle zuweisen. 27
Nach dem Speichern der Gruppe, können Sie nun Benutzer dieser Gruppe zuweisen. Klicken Sie dafür den Einstellungen Button neben der gewünschten Gruppe und wählen Benutzer verwalten. 28
3 Lesezeichen "Lesezeichen" Die Lesezeichen geben dem Admin die Möglichkeit eine Liste von Links zur Oberfläche hinzuzufügen. Diese wird auf der linken Seite Ihrer Neuigkeiten angezeigt. Klicken Sie auf eines der Lesezeichen, öffnet sich der Link in einem neuen Tab Ihres Browsers. Ihre Lesezeichen 29
3.1 Private Lesezeichen Neben den vom Admin festgelegten Lesezeichen, hat jeder Nutzer die Möglichkeit sich seine eigenen Lesezeichen anzulegen. Diese werden dann ebenfalls auf der linken Seite Ihrer Neuigkeiten angezeigt. 30
4 Design 31
Das Design der Applikation kann der Firmenidentität des Unternehmens angepasst werden. Die Farben, so wie das Logo können dementsprechend angepasst werden. Damit die Änderungen übernommen werden, ist es möglich, dass Sie den Cache Ihres Browsers leeren müssen. 32
5 Kategorien Kategorien sollen dabei helfen Seiten und Workspaces in verschiedene Kategorien zu ordnen. Sie sollen dem Administrator und Nutzer eine bessere Übersicht über die Seiten und Workspaces verschaffen. Die Kategorien werden Ihnen nun als Tabs in der Seiten- oder Workspace-Übersicht angezeigt. Wenn Sie nun eine Seite erstellen oder editieren, werden Ihnen die Kategorien als Auswahlmöglichkeit angeboten. 33
34
6 Teaser "Teaser" Aktive Teaser werden jedem Nutzer in einer Slideshow auf der Hauptseite angezeigt. Um einen neuen "Teaser" hinzuzufügen, klicken Sie auf "Neuer Teaser" Geben Sie die benötigten Informationen ein: 35
Wenn die Eigenschaften eines Teasers geändert werden müssen, klicken Sie auf das Zahnrad neben "Neuer Teaser" Hier können Sie alle Eigenschaften des Teasers ändern: 36
37
7 Statistiken Aktivieren/Deaktivieren der Statistik Um die Statistiken für Ihr System zu aktivieren, stellen Sie zunächst sicher, dass Sie Super Admin Ihres Systems sind. Dies ist Voraussetzung für den Zugang zum Administrationsbereich Ihrer Applikation. Sind Sie Super Admin wählen Sie den Punkt Einstellungen>Allgemein in der Navigationsleiste. Unter dem Punkt Statistiken/Tracking können Sie nun die Statistiken aktivieren, bzw. deaktivieren. Mit dem Statistik Modul können Sie sich einen Überblick über die Nutzung des Systems verschaffen. Sie können sich über beliebig definierbare Zeiträume, Grafiken und Informationen über aktive Nutzer, Besuche, Seitenaufrufe, Beiträge, Kommentare, aktive Workspaces, Anzahl der Seiten, heutige Termine und likes anzeigen lassen. Grafiken anzeigen lassen Um sich die Grafiken anzeigen zu lassen, wählen Sie zunächst den Administrationsbereich aus. Nun können Sie sich für eine Statistik Ihrer Wahl anzeigen lassen, wie zum Beispiel Likes in der Woche, Kommentare in der Woche, oder Pageviews. Zunächst wird Ihnen die Statistik der letzten 7 Tage angezeigt. Möchten Sie sich die Statistik über einen anderen Zeitraum anzeigen lassen, wählen Sie ein anderes Datum, und legen Sie einen anderen Zeitraum fest. Im unten angezeigten Beispiel werden die Pageviews der letzten 2 Monate angezeigt. 38
39
8 REST API REST ist ein moderner Web Service der es einer Applikation erlaubt, bestimmte Daten und Funktionen über simple HTTP Aufrufe zur Verfügung zu stellen. Die REST API besteht aus folgenden Komponenten: Public API ActivityStream API Notifications API Messaging API Wall API User API 8.1 Authentifizierung via REST API Es gibt 3 Möglichkeiten sich mit dem REST Client gegenüber der API zu authentifizieren, so dass begrenzte API Methoden abgerufen werden können. Ihr Client kann entweder den Session basierten Authentifikations-Mechanismus über /login nutzen, er kann die Nutzerdaten mit jedem Aufruf direkt über die Applikation durchlaufen, oder er nutzt den built-in authtoken Mechanismus. 8.1.1 Authentifizierung via session Die Authentifizierung ist nur möglich, wenn Sie einen Client nutzen der Session und Cookie Daten sichern kann. Stellen Sie sicher, dass Sie sich ausschließlich über gesicherte SSL Verbindungen authentifizieren. Um Ihren Client mit dem System zu authentifizieren, machen Sie einen POST Aufruf zur URL /login mit dem Benutzernamen und Passwort des Parameters. Params: username, password HTTP method: POST URL: /login Security: none / public 8.1.2 Authentifizierung mit Benutzeranmeldedaten Die folgende Authentifizierungsmethode der REST API ist sehr unsicher, da die Anmeldedaten direkt durch die HTTP Parameter, nur mit einer leichten Base64 Verschlüsselung, weitergereicht werden. Stellen Sie sicher, dass Sie diese Authentifizierungsmethode ausschließlich über eine gesicherte SSL Verbindung nutzen. 40
Wenn eine API Methode eine Authentifizierung benötigt, übergeben Sie die grundlegende Authentifizierung (base 64 encoded) auf diesem Wege: username: Benutzername oder Email des Benutzers password: Das Passwort des Benutzers Bitte beachten Sie, dass das System seit der Version 3.0 Preemtive Authentifikation benutzt. Für weitere Informationen sehen Sie sich die Apache Documentation on Preemptive Authentication an. 8.1.3 Authentifizierung mit Token Jeder erfolgreiche API Request mit einer der oben genannten Authentifizierungs-Methoden, liefert einen Response Header "auth-token", der die API Token des Benutzers enthält. Der API Token sollte nun weiterhin für weitere API Calls genutzt werden, in dem man ihn mit jedem weiteren Request als einen Request Header "auth-token" durchlaufen lässt. So müssen Sie sich nur einmal mit der Basic Authentifizierung authentifizieren und können den API Token für weiter API Calls verwenden. 8.2 API methoden 8.2.1 Public API GET: info() Gibt allgemeine Applikations Informationen (zum Beispiel aktuelle Version) wieder. Externe Applikationen benutzen diese Methode um zu prüfen, ob gewisse Dienste unterstützt werden. HTTP method: GET URL: /api/info (old: /api/public/info) Format: JSON Security: none / public GET: ping() Gibt den HTTP Response Code 200 OK wieder wenn dieser aufgerufen wird. Dies kann für Monitoring Zwecke genutzt werden und um sicher zu stellen das die Applikation läuft. HTTP method: GET URL: /api/ping Format: HTTP Security: none / public 8.2.2 ActivityStream API GET: count() 41
Gibt den Zähler aller ungelesenen neuen Beiträge in den aktuellen Neuigkeiten wieder. HTTP method: GET URL: /api/stream/count (old /api/stream/unread) Format: JSON Security: auth GET: stream(int limit) Gibt den Newsfeed des aktuellen Nutzers wieder. Params: limit: limit the number of rows returned (default 50) HTTP method: GET URL: /api/stream Format: JSON Security: auth POST: post(string message) Erstellt einen neuen Beitrag auf der Pinnwand des aktuellen Nutzers und gibt diesen Beitrag wieder. Params: message: the text message to post HTTP method: POST URL: /api/stream/post Format: JSON Security: auth 8.2.3 Messaging API GET: count() Gibt die Anzahl der ungelesenen privaten Nachrichten des aktuellen Nutzers wieder. HTTP method: GET URL: /api/messaging/count Format: JSON Security: auth GET: conversations(conversationstatus status, boolean active) Gibt alle Unterhaltungen mit dem passenden Kriterium als JSON wieder. Der Status kann einer der folgenden sein: INBOX, ARCHIVED, INVISIBLE or DELETED HTTP method: GET 42
URL: /api/messaging/conversations Format: JSON Security: auth PUT: status(conversationstatus status) Ändert den Status von Unterhaltungen mit der gegebenen ID. Der Status kann einer der folgenden sein: INBOX, ARCHIVED, INVISIBLE or DELETED HTTP method: PUT URL: /api/messaging/conversations/{id}/status Format: JSON Security: auth PUT: active(boolean active) Setzt den Aktiv Status von Unterhaltungen mit der gegebenen ID. HTTP method: PUT URL: /api/messaging/conversations/{id}/active Format: JSON Security: auth DELETE: delete(long id) Entfernt den Benutzer (Mitglied der Unterhaltung) mit der gegebenen ID aus der Unterhaltung. Die angegebene ID muss die ID des Mitgliedes der Unterhaltung sein, nicht die des Benutzer selbst. HTTP method: DELETE URL: /api/messaging/conversations/{id} Format: JSON Security: auth GET: posts(long beforeid, Long afterid, Long modifiedafter) Gibt alle Beiträge der durch die ID des Unterhaltungsmitgliedes identifizierten Unterhaltung wieder. Optionale Parameter können hinzugefügt werden, um das Ergebnis einzugrenzen. Geben Sie die ID eines Beitrages als beforeid oder afterid an, um nur Beiträge zu erhalten, die vor oder nach dem angegebenen Beitrag erstellt wurden. Es ist auch möglich ein Datum anzugeben, um nur Beiträge zu erhalten, die nach dem angegebenen Datum erstellt wurden. HTTP method: GET URL: /api/messaging/conversations/{id}/posts Format: JSON 43
Security: auth POST: write(json postdata) Fügt einen neuen Beitrag zu der Unterhaltung hinzu, die durch die ID des Unterhaltungsmitgliedes identifiziert wird. Die Daten des Beitrages müssen als JSON Daten mit Inhalt der Nachricht übertragen werden (zum Beispiel {message: "This is the message."}) HTTP method: POST URL: /api/messaging/conversations/{id}/posts Format: JSON Security: auth 8.2.4 Wall API GET: posts(long id, int limit) Gibt die Beiträge einer Pinnwand mit einer bestimmten ID zurück. Params: id: ID of the wall, limit: limit the number of rows returned (default 50) HTTP method: GET URL: /api/wall Format: JSON Security: auth POST: post(long id, string message, List files) Erstellt einen neuen Beitrag auf der Pinnwand mit einer speziellen ID und gibt diesen Beitrag wieder. Optional können eine oder mehrere Dateien an diesen Post angehängt werden. In diesem Fall muss der Content-Type innerhalb des Request Header wie folgt lauten: "multipart/form-data". Params: id: ID of the wall, message: the text message to post, files: one or more files as binary data. HTTP method: POST URL: /api/wall/post Format: JSON Security: auth 8.2.5 User API GET: current() Gibt den aktuellen Benutzer wieder. HTTP method: GET 44
URL: /api/user/current Format: JSON Security: auth GET: user() Gibt den Nutzer mit der angegebenen ID als JSON wieder. HTTP method: GET URL: /api/user/{id} Format: JSON Security: auth POST: user() Erstellt einen neuen Benutzer. Als Rückgabe wird der neue Benutzer als JSON-Objekt zurückgeliefert oder im Fehlerfall die Fehlermeldung / die Fehlermeldungen. Der neu angelegte Benutzer wird beim ersten Login aufgefordert sein Passwort zu ändern. HTTP method: POST Params: "user": data for creating a new user. The object must contain the following parameters: "firstname", "lastname", "email", "password". Optionally the parameters "groupid" and "roleid" can be passed to assign the new user to a group or a role. If no IDs where passed, the user will be assigned to the default group / default role if existing. URL: /api/user Format: JSON Security: auth / token Example: Request-Body: {firstname : "Ian", lastname : "Bold", email : "ian.bo GET: list() Gibt eine Liste aller Benutzer sortiert nach Nachname zurück. Die Liste kann mit Hilfe der Parameter "filterfield" und "filterquery" zusätzlich sortiert werden. Wenn die für den Filter gesetzten Werte ungültig oder nicht vorhanden sind, wird die vollständige Liste zurückgeliefert. Die Rückgabe kann zudem über die Parameter "page" und "length" seitenweise erfolgen. Die Rückgabe enthält zu dem die Gesamtanzahl aller Nutzer für die gestellte Anfrage. HTTP method: GET Params: 45
filterfield: (optional) Specifies the field to filter users by. Possible values: "onlinestatus", "name", "email", jobtitle", "expertise", "department", "office", "company", "country" filterquery: (optional) Any text to filter for or a valid online status like "ONLINE", "OFFLINE", "BUSY" or "AWAY" if "onlinestatus" is set as field. URL: /api/users Format: JSON Security: auth GET: colleagues() Gibt eine Liste aller Benutzer, die dem aktuellen Benutzer folgen, wieder. Die Benutzer in der wiedergegebenen Liste werden alphabetisch nach Ihren Nachnamen sortiert. HTTP method: GET URL: /api/users/colleagues Format: JSON Security: auth 8.2.6 Notifications API GET: notifications() Gibt die letzten 30 Benachrichtigungen des aktuellen Nutzers wieder. HTTP method: GET URL: /api/notifications Format: JSON Security: auth GET: count() Gibt die Anzahl der ungelesenen neuen Benachrichtigungen des aktuellen Benutzers wieder. HTTP method: GET URL: /api/notifications/count Format: JSON Security: auth GET: unread() Gibt die ungelesenen neuen Benachrichtigungen des aktuellen Benutzers wieder. HTTP method: GET 46
URL: /api/notifications/unread Format: JSON Security: auth POST: markread() Markiert alle Benachrichtigungen des aktuellen Benutzers als gelesen, und gibt nichts wieder. HTTP method: POST URL: /api/notifications/read/all Format: JSON Security: auth 47
9 Superadmin Modus Der Superadmin Modus wird aktiviert, in dem Sie den Einstellungen Button in der oberen rechten Ecke klicken und Superadmin aktivieren auswählen. Diese Möglichkeit wird Ihnen nur angezeigt, wenn Sie in der Benutzerverwaltung als Super Administrator ausgewählt sind. Als Superadmin haben Sie Zugang zum Administrationsbereich und Zugang zu jeder Seite und jedem Workspace, auch geschlossene und private. Sie bekommen die Möglichkeit auf alle Inhalte des Systems zuzugreifen, außer auf private Nachrichten. Zusätzlich versetzt Sie der Superadmin Modus in die Lage Kommentare und Beiträge zu löschen. 48