Maltea (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung |
||
| (6 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt) | |||
| Zeile 9: | Zeile 9: | ||
| API Keys für UTM Monitoring nutzen | | API Keys für UTM Monitoring nutzen | ||
| Using API Keys for UTM Monitoring }} | | Using API Keys for UTM Monitoring }} | ||
{{var | | {{var | Einleitung | ||
| Einleitung | |||
| }} | |||
{{var | Einleitung--desc | |||
| API Keys ermöglichen für andere Anwendungen eine Authentifizierung im USC Portal.<br>Dabei haben die API Keys einen festgelegten Geltungsbereich der z.Zt. ausschließlich Metriken für ein Monitoring umfasst. | | API Keys ermöglichen für andere Anwendungen eine Authentifizierung im USC Portal.<br>Dabei haben die API Keys einen festgelegten Geltungsbereich der z.Zt. ausschließlich Metriken für ein Monitoring umfasst. | ||
| API Keys enable authentication in the USC Portal for other applications.<br>The API keys have a defined scope that currently only includes metrics for monitoring. }} | | API Keys enable authentication in the USC Portal for other applications.<br>The API keys have a defined scope that currently only includes metrics for monitoring. }} | ||
{{var | Securepoint API-Dokumentation | |||
| Hier gibt es eine Übersicht über die [https://portal.securepoint.cloud/api-docs/#/ Securepoint API-Dokumentation] | |||
| }} | |||
{{var | Übersicht | |||
| Übersicht | |||
| }} | |||
{{var | Allgemeine Optionen | |||
| Allgemeine Optionen | |||
| }} | |||
{{var | Suche | |||
| Suche | |||
| Search }} | |||
{{var | Suche--desc | |||
| Filtert die Anzeige | |||
| Filters the display }} | |||
{{var | Sortieren | |||
| Sortieren | |||
| }} | |||
{{var | Sortieren--desc | |||
| Per Klick auf diese Schaltfläche öffnet sich ein Menü, indem nach bestimmten Kriterien die Kacheln sortiert werden können | |||
| }} | |||
{{var | Name | |||
| Name | |||
| }} | |||
{{var | Aufsteigend | |||
| Aufsteigend/Absteigend | |||
| Ascending/Descending }} | |||
{{var | Aufsteigend--desc | |||
| Zeigt die Suchergebnisse alphabetisch aufsteigen/absteigend an | |||
| Displays the search results alphabetically ascending/descending }} | |||
{{var | Beschreibung | {{var | Beschreibung | ||
| Funktionsumfang | | Funktionsumfang | ||
| Scope of functions }} | | Scope of functions }} | ||
{{var | | {{var | Übersicht anzeigen | ||
| | | Übersicht anzeigen | ||
| Show | | Show overview }} | ||
{{var | Beschreibung--Bild | {{var | Beschreibung--Bild | ||
| | | USP_2.14_API_Keys.png | ||
| | | USP_2.14_API_Keys-en.png }} | ||
{{var | Beschreibung--cap | {{var | Beschreibung--cap | ||
| API Keys im USC Portal | | API Keys im USC Portal | ||
| API Keys in the USC Portal }} | | API Keys in the USC Portal }} | ||
{{var | Kacheloptionen | |||
| Kacheloptionen | |||
| }} | |||
{{var | Kacheldetails--desc | |||
| Folgende Details werden in der Kachel angezeigt | |||
| }} | |||
{{var | Mandanten--Details--desc | |||
| Zeigt die Mandanten an, für die die API angewendet wird | |||
| }} | |||
{{var | Geltungsbereich--Details--desc | |||
| Zeigt die Geltungsbereiche der API an | |||
| }} | |||
{{var | Schlüssel | |||
| Schlüssel | |||
| }} | |||
{{var | Schlüssel--Details--desc | |||
| Über die Schaltfläche {{spc|copy|b|In Zwischenablage kopieren}} wird der Schlüssel des API Key in die Zwischenablage kopiert | |||
| }} | |||
{{var | Kacheloptionen--Burgermenu | |||
| Mit der Schaltfläche {{spc|menu|o|-}} oben rechts in jeder Profilkachel stehen folgende Optionen zur Verfügung | |||
| }} | |||
{{var | Bearbeiten | |||
| Bearbeiten | |||
| }} | |||
{{var | Bearbeiten--desc | |||
| Der {{b|Kommentar}}-Parameter des API Keys ist bearbeitbar | |||
| }} | |||
{{var | Löschen | |||
| Löschen | |||
| }} | |||
{{var | Löschen--desc | |||
| Der API Key wird gelöscht | |||
| }} | |||
{{var | 1=Menu | {{var | 1=Menu | ||
| 2=<span class="MS spc__menu bc__grau-menu border-color__grau-menu font-color__white pipe-left">{{spc|typ|m|Allgemein}} {{spc|key|m|API Keys}}</span> | | 2=<span class="MS spc__menu bc__grau-menu border-color__grau-menu font-color__white pipe-left">{{spc|typ|m|Allgemein}} {{spc|key|m|API Keys}}</span> | ||
| Zeile 34: | Zeile 97: | ||
| Add API Key }} | | Add API Key }} | ||
{{var | API Key hinzufügen--Bild | {{var | API Key hinzufügen--Bild | ||
| | | USP_2.14_API_Key_hinzufuegen.png | ||
| | | USP_2.14_API_Key_hinzufuegen-en.png }} | ||
{{var | API Key hinzufügen--desc | {{var | API Key hinzufügen--desc | ||
| API Key | | Fügt einen neuen API Key hinzu | ||
| | | Adding a new API Key }} | ||
{{var | Name--desc | {{var | Name--desc <!----Update----> | ||
| Aussagekräftiger Name für den API-Key | | Aussagekräftiger einmaliger Name für den API-Key | ||
{{Hinweis-box|Muss mindestens aus 3 Zeichen bestehen}} | |||
| Meaningful name for the API key }} | | Meaningful name for the API key }} | ||
{{var | Für alle Mandanten | |||
| Für alle Mandanten | |||
| For all Tenants }} | |||
{{var | Für alle Mandanten--desc | |||
| Bei Aktivierung {{ButtonAn||class=small}} wird diesem API Key Zugriff auf alle Mandanten gewährt | |||
| When activated, {{ButtonAn||class=small}} grants this API key access to all tenants }} | |||
{{var | Mandanten | {{var | Mandanten | ||
| Mandanten | | Mandanten | ||
| Clients }} | | Clients }} | ||
{{var | Mandanten--desc | {{var | Mandanten--desc | ||
| Mandanten, für die die API Werte ausgibt | | Mandanten, für die die API Werte ausgibt | ||
| Clients for which the API outputs values | | Clients for which the API outputs values }} | ||
{{var | Mandanten--Hinweis | {{var | Mandanten--Hinweis | ||
| Wird kein Mandant angegeben, werden Werte für '''sämtliche Mandanten und den Reseller selbst''' ausgegeben! | | Wird kein Mandant angegeben, werden Werte für '''sämtliche Mandanten und den Reseller selbst''' ausgegeben! | ||
| Zeile 54: | Zeile 124: | ||
| Geltungsbereich | | Geltungsbereich | ||
| Scope }} | | Scope }} | ||
{{var | Geltungsbereich--desc | {{var | Geltungsbereich--desc <!----UPDATE----> | ||
| | | * Die möglichen Geltungsbereiche für den API Key | ||
* Jeder Geltungsbereich kann bestimmte Rechte gegeben werden, durch die Aktivierung der jeweiligen Schaltfläche {{ButtonAn||class=small}} | |||
* Folgende Rechte stehen zur Auswahl: '''Alle''', '''Erstellen''', '''Lesen''', '''Aktualisieren''', '''Löschen''' {{info|Wird das Recht '''Alle''' aktiviert {{ButtonAn||class=small}}, werden die anderen Rechte automatisch auch aktiviert}} | |||
: {{Hinweis-box|Mindestens ein Geltungsbereich muss aktiv sein}} | |||
{{var | Metriken | |||
| Metriken | |||
| }} | |||
{{var | Metriken--desc | |||
| Lediglich das '''Lesen'''-Recht steht zur Verfügung | |||
| }} | |||
{{var | Mandanten Administration | |||
| Mandanten Administration | |||
| }} | |||
{{var | Alle Rechte stehen zur Verfügung | |||
| Alle Rechte stehen zur Verfügung | |||
| }} | |||
{{var | Cloud Shield Administration | |||
| Cloud Shield Administration | |||
| }} | |||
{{var | Unified Reporting Administration | |||
| Unified Reporting Administration | |||
| }} | |||
{{var | Uneingeschränkt | |||
| Uneingeschränkt | |||
| }} | |||
{{var | USC--Rechte | |||
| * Alle Rechte stehen zur Verfügung | |||
* Wird ein Recht aktiviert {{ButtonAn||class=small}}, wird dieses Recht auch für die Unterbereiche entsprechend aktiviert | |||
* Für eine bessere Übersicht kann mit einem Klick auf {{spc|fa|o|-|class=fal fa-folder-open}} / {{spc|fa|o|-|class=fal fa-folder}} die Unterbereiche ausgeblendet/eingeblendet werden | |||
| }} | |||
{{var | Unified Security Console Administration | |||
| Unified Security Console Administration | |||
| }} | |||
{{var | Keine Löschen Rechte | |||
| Alle Recht bis auf '''Löschen''' steht zur Verfügung | |||
| }} | |||
{{var | Aktivierung auch in VPN-Konfiguration | |||
| Bei einer Rechteaktivierung wird auch das entsprechende Recht im Geltungsbereich {{b|VPN-Konfiguration}} aktiviert | |||
| }} | |||
{{var | UTM Administration | |||
| UTM Administration | |||
| }} | |||
{{var | UTM Zero-Touch Administration | |||
| UTM Zero-Touch Administration | |||
| }} | |||
{{var | Windows Administration | |||
| Windows Administration | |||
| }} | |||
{{var | Access Point Administration | |||
| Access Point Administration | |||
| }} | |||
{{var | VPN-Konfiguration | |||
| VPN-Konfiguration | |||
| }} | |||
{{var | VPN-Konfiguration--Rechte | |||
| * Alle Rechte stehen zur Verfügung | |||
* Wird ein Recht aktiviert {{ButtonAn||class=small}}, wird dieses Recht auch für die Unterbereiche entsprechend aktiviert | |||
* Für eine bessere Übersicht kann mit einem Klick auf {{spc|fa|o|-|class=fal fa-folder-open}} / {{spc|fa|o|-|class=fal fa-folder}} die Unterbereiche ausgeblendet/eingeblendet werden | |||
| }} | |||
{{var | Aktivierung auch in USC | |||
| Bei einer Rechteaktivierung wird auch das entsprechende Recht im Geltungsbereich {{b|USC}} aktiviert | |||
| }} | |||
{{var | Mobile Security Administration | |||
| Mobile Security Administration | |||
| }} | |||
| Scope for the API key. Currently only ''Metrics'' available }} | | Scope for the API key. Currently only ''Metrics'' available }} | ||
{{var | Ablaufdatum | {{var | Ablaufdatum | ||
| Zeile 64: | Zeile 198: | ||
| Choose a date }} | | Choose a date }} | ||
{{var | Ablaufdatum--desc | {{var | Ablaufdatum--desc | ||
| Es muss ein Ablaufdatum gewählt werden | | Es muss ein Ablaufdatum gewählt werden<br> Soll die Geltungsdauer später geändert werden, ist es lediglich möglich, den API-Key zu löschen | ||
| An expiration date must be selected | | An expiration date must be selected<br> In case the validity period is to be changed later, it is only possible to delete the API key }} | ||
{{var | Kommentar | {{var | Kommentar | ||
| Kommentar | | Kommentar | ||
| Zeile 79: | Zeile 213: | ||
| Save }} | | Save }} | ||
{{var | Speichern--desc | {{var | Speichern--desc | ||
| Legt den API-Key an und schließt den Dialog | | Legt den API-Key an und schließt den Dialog | ||
| Creates the API key and closes the dialog. }} | | Creates the API key and closes the dialog }} | ||
{{var | Speichern-- | {{var | Speichern--Dialog--Bild | ||
| | | USP_2.14_API_Key_hinzufuegen_Dialog.png | ||
| USP_2.14_API_Key_hinzufuegen_Dialog-en.png }} | |||
{{var | Speichern--Dialog--desc | |||
| Ein Dialogfenster öffnet sich, indem der generierte API Key angezeigt wird. | |||
* {{spc|copy|b|Kopieren}} kopiert den API Key in die Zwischenablage | |||
* {{spc|fa|b|Schließen|class=fal fa-xmark}} schließt den Dialog | |||
{{Hinweis-box|Den API Key bitte notieren. Aus Sicherheitsgründen wird der API Key nur einmalig angezeigt und kann später nicht mehr angezeigt werden!|fs__icon=em2}} | |||
| }} | |||
{{var | Speichern--Hinweis <!----UPDATE----> | |||
| Lediglich der Parameter ''Kommentar'' lässt sich später noch bearbeiten | |||
| The values for ''Client, Scope'' and ''Expiration Date'' cannot be changed afterwards. }} | | The values for ''Client, Scope'' and ''Expiration Date'' cannot be changed afterwards. }} | ||
{{var | In Zwischenablage kopieren | {{var | In Zwischenablage kopieren | ||
| Zeile 102: | Zeile 245: | ||
| Das folgende Beispiel setzt eine funktionsfähige Installation folgender Produkte voraus: | | Das folgende Beispiel setzt eine funktionsfähige Installation folgender Produkte voraus: | ||
* Linux VM | * Linux VM | ||
* Prometheus (Opensource | * Prometheus (Opensource Monitoring) | ||
* Grafana (Open-Source-Anwendung zur grafischen Darstellung von Daten) | * Grafana (Open-Source-Anwendung zur grafischen Darstellung von Daten) | ||
* ngninx (Webserver) | * ngninx (Webserver) | ||
| The following example assumes a working installation of: | | The following example assumes a working installation of: | ||
* Linux VM | * Linux VM | ||
* Prometheus (Opensource | * Prometheus (Opensource Monitoring) | ||
* Grafana (Open source application for graphical representation of data) | * Grafana (Open source application for graphical representation of data) | ||
* ngninx (Webserver) }} | * ngninx (Webserver) }} | ||
USC/Api-Keys.lang: Unterschied zwischen den Versionen
Aus Securepoint Wiki