Änderungen von Dokument Server-Administration
Zuletzt geändert von MACH ProForms GmbH am 04.07.2024
Von Version 383.1
bearbeitet von MACH ProForms GmbH
am 24.02.2021
am 24.02.2021
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 510.1
bearbeitet von MACH ProForms GmbH
am 06.08.2021
am 06.08.2021
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
-
Anhänge (8 geändert, 2 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -2,13 +2,13 @@ 2 2 3 3 Einem Benutzer stehen, je nach definierten [[Benutzerrechten|Main.07_Einstellungen-Fachadministration.02_Benutzer.01_Benutzerrollen]], die Funktion/der Menüpunkt „Server-Administration“ zur Verfügung. Der Menüpunkte befindet sich in dem Hauptmenüpunkt „Einstellungen“ in der „[[Hauptnavigationsleiste|Main.03_Hauptnavigationsleiste]]“ und beinhalten weitere Menüpunkte/Funktionen. 4 4 5 -> ***Hinweis:*** 5 +> {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:*** 6 6 > Diese Funktion steht nur Serveradministratoren zur Verfügung. 7 7 8 8 ![[Ansicht des Hauptmenüpunkts „Server-Administration“|@ServerAdministrationHauptmenüpunkt.jpg]] 9 9 ___ 10 10 11 -# Übersicht 11 +## Übersicht 12 12 13 13 Nach dem Betätigen des Menüpunkts „Server-Administration“ gelangt man auf eine Übersichtsseite. Dieser Bereich befindet sich derzeit noch im Aufbau und wird in Kürze weitere Funktionen beinhalten. 14 14 ... ... @@ -16,13 +16,13 @@ 16 16 17 17 ___ 18 18 19 -# API-Keys 19 +## API-Keys 20 20 21 21 Unter dem Menüpunkt „API-Keys“ gelangt man in die Verwaltung der API-Keys. Hier können neue sowie bereits angelegte API-Keys verwaltet werden. 22 22 23 23 ![[Ansicht der „API-Key-Übersicht“|@ServerAdministrationAPIKEY.jpg]] 24 24 25 -## Filter in der API-Keys-Übersicht 25 +### Filter in der API-Keys-Übersicht 26 26 27 27 Über die Filter in der API-Keys-Übersicht kann nach einem/mehreren API-Keys gesucht werden. Folgende Filtermöglichkeiten stehen hierzu zur Verfügung: 28 28 ... ... @@ -55,9 +55,9 @@ 55 55 56 56 ![[Ansicht der Filter|@ApiKeyFilter.jpg]] 57 57 58 -## Neuer API-Key anlegen ![[Schaltfläche „Neuer API-Key anlegen“|@ApiKeyNeueHinzufügen.jpg]] 58 +### Neuer API-Key anlegen ![[Schaltfläche „Neuer API-Key anlegen“|@ApiKeyNeueHinzufügen.jpg]] 59 59 60 -Neue API-Keys können über die Schaltfläche „Hinzufügen“ in der API-Key-Übersicht angelegt werden. Daraufhin öffnet sich die Eingabemaske „API-Key anlegen“, in der die Daten zum API-Key hinterlegt werden können. Folgende Daten müssen angegeben werden:60 +Neue API-Keys können über die Schaltfläche „Hinzufügen“ in der API-Key-Übersicht angelegt werden. Daraufhin öffnet sich die Eingabemaske „API-Key anlegen“, in der die Daten zum API-Key hinterlegt werden können. Folgende Stammdaten müssen angegeben werden: 61 61 62 62 - **API-Key** <br /> 63 63 Hier wird ein entsprechender API-Key beim Anlegen generiert. Da dieser Wert nicht verändert werden darf, ist das Feld schreibgeschützt. ... ... @@ -86,15 +86,27 @@ 86 86 - **Zertifikatsdatei**<br /> 87 87 Hier kann die entsprechende Datei, welche als Zertifikat verwendet werden soll, hochladen werden. Es sind Formate nach dem Standard X.509 zugelassen. 88 88 89 - Nach der EingabellererforderlichenDaten kann derAPI-Keyüber die Schaltfläche„Speichern“gespeichert werden.DerErsteller wirddaraufhin wieder indie „API-Key-Übersicht“ weitergeleitet inder ein neuer Eintrag erstellt wurde.89 +![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Stammdaten|@ApiKeyAnlegen_Stammdaten.jpg]] 90 90 91 -![[Ansicht der Eingabemaske "Neuer API-Key anlegen"|@ApiKeyAnlegen.jpg]] 92 92 93 - ##API-Keybearbeiten![[Schaltfläche„API-Keybearbeiten“|@ApiKeyBearbeiten.jpg]]92 +Es ist außerdem verpflichtend dem API-Key vor dem Speichern eine der unten aufgeführten Berechtigungen zuzuweisen. 94 94 94 +- **SecurePostData**<br /> 95 +Mit diesem Recht kann der API-Key für die Authentifizierung zur Nutzung der [SecurePostData-Schnittstelle](https://wiki.form-solutions.de/wiki/admindoku/view/Main/03_Steuerungsprozess/02_Vorbef%C3%BCllung/02_SecurePostdata/) verwendet werden. 96 +Es wird empfohlen pro Mandant lediglich einen API-Key mit diesem Recht zu versehen, um eine Eindeutigkeit des verwendeten Schlüssels zu gewährleisten. 97 + 98 +- **Unbegrenzt**<br /> 99 +Mit diesem Recht kann der API-Key für alle vorgesehenen Schnittstellen von Form-Solutions verwendet werden. 100 + 101 +![[Ansicht der Eingabemaske "Neuer API-Key anlegen" - Berechtigungen|@ApiKeyAnlegen_Berechtigungen.jpg]] 102 + 103 +Nach der Eingabe aller erforderlichen Daten kann der API-Key über die Schaltfläche „Speichern“ gespeichert werden. Der Ersteller wird daraufhin wieder in die „API-Key-Übersicht“ weitergeleitet in der ein neuer Eintrag erstellt wurde. 104 + 105 +### API-Key bearbeiten ![[Schaltfläche „API-Key bearbeiten“|@ApiKeyBearbeiten.jpg]] 106 + 95 95 Müssen die Daten zu einem API-Key geändert werden, so kann dies ein Benutzer, der das entsprechende Recht hat. Hierzu steht die Schaltfläche „Bearbeiten“ in der API-Key-Übersicht direkt am entsprechenden API-Key zur Verfügung. Nach dem Öffnen gelangt man direkt in die Eingabemaske „API-Key bearbeiten“, in der die Daten zum API-Key hinterlegt sind. Nach der Eingabe der geänderten Daten und dem Hochladen eines gültigen Zertifikats muss über die Schaltfläche „Speichern“ der API-Key gespeichert werden. 96 96 97 -## API-Key löschen ![[Schaltfläche „API-Key löschen“|@ApiKeyLöschen.jpg]] 109 +### API-Key löschen ![[Schaltfläche „API-Key löschen“|@ApiKeyLöschen.jpg]] 98 98 99 99 Muss ein API-Key gelöscht werden, kann das ein Benutzer, mit dem entsprechenden Recht, in der API-Key-Übersicht. Hierzu steht neben jedem API-Key die Schaltfläche „Löschen“ zur Verfügung. 100 100
- ApiKeyAnlegen.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 - 95.8KB1 +106.6 KB - Inhalt
- ApiKeyBearbeiten.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -1. 2KB1 +1.1 KB - Inhalt
- ApiKeyFilter.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -1 3.6KB1 +15.0 KB - Inhalt
- ApiKeyLöschen.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -1. 2KB1 +1.1 KB - Inhalt
- ApiKeyNeueHinzufügen.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -1. 1KB1 +1.0 KB - Inhalt
- ServerAdministrationAPIKEY.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -1 40.1 KB1 +131.1 KB - Inhalt
- ServerAdministrationHauptmenüpunkt.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 - 83.7KB1 +66.8 KB - Inhalt
- ServerAdministrationÜbersicht.jpg
-
- Größe
-
... ... @@ -1,1 +1,1 @@ 1 -6 6.1KB1 +62.0 KB - Inhalt
- ApiKeyAnlegen_Berechtigungen.jpg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.Dokumentation - Größe
-
... ... @@ -1,0 +1,1 @@ 1 +81.9 KB - Inhalt
- ApiKeyAnlegen_Stammdaten.jpg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.Dokumentation - Größe
-
... ... @@ -1,0 +1,1 @@ 1 +136.5 KB - Inhalt