Anwendungsschlüssel
Anwendungsschlüssel sind in der ThingWorx Datenbank verschlüsselte Sicherheits-Token, die statt Standard-Anmeldeinformationen verwendet werden können, um sich bei der ThingWorx Anwendung anzumelden.
Sie können Anwendungsschlüssel-Token in der Kopfzeile in der URL einer Anforderung übergeben. Die Anforderung wird mit dem Sicherheitskontext des Benutzers ausgeführt, der dem Anwendungsschlüssel zugeordnet ist. Standardmäßig wird keine Sitzung erstellt, wenn eine Anforderung mit einem Anwendungsschlüssel vorgenommen wird. Dies ist die empfohlene Methode für andere Systemen und Anwendungen für eine Anforderung bei der ThingWorx Anwendung. Wenn Sie jedoch eine Sitzung erstellen möchten, können Sie den folgenden Abfrageparameter zusätzlich zum Anwendungsschlüssel-Token verwenden:x-thingworx-session=true.
Wenn Sie ein Mashup über eine URL anzeigen und einen Anwendungsschlüssel verwenden, erstellen Sie eine Sitzung, indem Sie x-thingworx-session=true hinzufügen. Ohne eine Sitzung ist für nachfolgende Anforderungen eine Authentifizierung unter Verwendung des standardmäßigen HTTP-Standardauthentifikators erforderlich. Fügen Sie x-thingworx-session=true nach dem Abfrageparameter #mashup=[your mashup name] hinzu.
 |
Sie sollten immer das Sicherheitskonzept der niedrigsten Berechtigung verwenden, wenn Sie Berechtigungen erstellen und diesen Anwendungsschlüsseln zuweisen. Es ist nicht empfehlenswert, ein Mitglied der Gruppe "Administrator" einem Anwendungsschlüssel zuzuweisen. Eine Warnung wird angezeigt, wenn Sie versuchen, einen Anwendungsschlüssel basierend auf einem Benutzer mit Administratorrechten zu erstellen.
|
Anwendungsschlüssel-Eigenschaften
|
Eigenschaftenname
|
Beschreibung
|
||
|---|---|---|---|
|
Name
|
Wort oder Phrase, das/die diesen Schlüssel identifiziert. Erforderliches Feld.
|
||
|
Avatar
|
Bild, das hochgeladen werden kann, um den Anwendungsschlüssel visuell darzustellen.
|
||
|
Beschreibung
|
Beschreibung des Anwendungsschlüssels.
|
||
|
Projekt
|
Arbeit oder Gruppe, die diesem Schlüssel zugeordnet ist.
|
||
|
Tags
|
Modell-Tags, die Sie zum Gruppieren oder Kategorisieren des Anwendungsschlüssels verwenden können.
|
||
|
IP-Zulassungsliste
|
Liste der zulässigen IPs, um mithilfe des Anwendungsschlüssels auf ThingWorx zuzugreifen. Trennen Sie die IPs durch ein Komma. Wenn die Eigenschaft nicht festgelegt wird, kann jede IP den Anwendungsschlüssel verwenden.
|
||
|
Client-Name
|
Vom Benutzer definierbares Feld (z.B. Client, der dem Anwendungsschlüssel zugeordnet wurde, oder IP-Adresse). ThingWorx ignoriert alle Werte, die diesem Feld zugewiesen werden.
|
||
|
Benutzernamenreferenz
|
Benutzername, der dem Anwendungsschlüssel zugeordnet ist. Erforderliches Feld.
|
||
|
Schlüssel-ID
|
Von ThingWorx generierter Schlüsselwert. Die Schlüssel-ID kann nicht bearbeitet werden.
|
||
|
Ablaufdatum
|
Ablaufdatum des Anwendungsschlüssels. Wenn kein Ablaufdatum angegeben wird, wird der Standardwert im Untersystem für Benutzerverwaltung verwendet. Anwendungsschlüssel laufen 24 Stunden nach ihrer Erstellung ab, wenn das Ablaufdatum nicht angegeben ist oder wenn der Wert der Anwendungsschlüssel-Lebensdauer (Sek.) im Untersystem der Benutzerverwaltung nicht geändert wird.
|
||
|
Datum der letzten Änderung
|
Datum und Uhrzeit der letzten Änderung des Anwendungsschlüssels.
|
||
|
Start-Mashup
|
Standard-Mashup, das dem Anwendungsschlüssel zugeordnet ist.
|
||
|
Dokumentation
|
Optionale Hinweise oder Hintergrundinformationen, die beschreiben, wie oder warum dies innerhalb der Umgebung verwendet wird.
|
Anwendungsschlüssel erstellen
Führen Sie die nachfolgenden Schritte aus, um einen Anwendungsschlüssel zu erstellen. Der erstellte Schlüssel übernimmt die Sicherheitseinstellungen, die dem zugeordneten Benutzer im Feld Benutzernamenreferenz gewährt wurden.
1. Klicken Sie in ThingWorx Composer auf Neu.
2. Führen Sie einen Bildlauf nach unten durch, und wählen Sie Anwendungsschlüssel aus.
3. Geben Sie im Feld Name einen Namen ein.
4. Falls gewünscht, wählen Sie Beschreibung, Projekt und Tags für diesen Schlüssel aus, oder geben Sie entsprechende Werte ein.
5. Wählen Sie im Feld Benutzernamenreferenz den Benutzer aus, der dem Anwendungsschlüssel zugeordnet ist.
6. Füllen Sie nach Wunsch alle optionalen Felder aus, einschließlich IP-Zulassungsliste, Client-Name, Start-Mashup, Avatar, Ablaufdatum oder Dokumentation.
|
|
Wenn Ablaufdatum nicht festgelegt ist, wird ein Wert aus dem Erstellungsdatum der Anwendungsschlüssel-Entität plus der Einstellung Anwendungsschlüssel-Lebensdauer (Sek.) im Untersystem der Benutzerverwaltung berechnet.
|
7. Klicken Sie auf Speichern.
8. Der Anwendungsschlüssel wird im Feld Schlüssel-ID angezeigt.
Anwendungsschlüssel löschen
Obwohl ein Ablaufdatum für einen Anwendungsschlüssel angegeben werden kann, wird er nicht automatisch gelöscht, wenn er abläuft. Sie können ThingWorx Anwendungslogik schreiben, die regelmäßig iteriert wird und abgelaufene Anwendungsschlüssel löscht. Siehe Anwendungsschlüssel-Dienste. So löschen Sie einen Anwendungsschlüssel manuell:
1. Navigieren Sie in Composer zu "Alle".
2. Führen Sie einen Bildlauf nach unten zum Bereich Sicherheit durch.
3. Erweitern Sie den Bereich, falls erforderlich, und suchen Sie Anwendungsschlüssel.
4. Wählen Sie einen Anwendungsschlüssel aus, indem Sie das Kontrollkästchen auf der linken Seite des Namens aktivieren.
5. Klicken Sie auf die Schaltfläche Löschen.
Anwendungsschlüssel über Dienste erstellen
Um einen Anwendungsschlüssel über einen Dienst zu erstellen, verwenden Sie das folgende Beispiel:
var params = {
clientName: undefined /* STRING */,
name: undefined /* STRING */,
description: undefined /* STRING */,
project: undefined /* STRING */,
whitelist: undefined /* STRING */,
user: undefined /* USERNAME */,
tags: undefined /* TAGS */,
expirationDate: undefined /* DATETIME */
};
// no return
Resources["EntityServices"].CreateApplicationKey(params);
//Get the generated Key's actual appKey value
var KeyID = ApplicationKeys["YOURKEYNAME"].GetKeyID();
clientName: undefined /* STRING */,
name: undefined /* STRING */,
description: undefined /* STRING */,
project: undefined /* STRING */,
whitelist: undefined /* STRING */,
user: undefined /* USERNAME */,
tags: undefined /* TAGS */,
expirationDate: undefined /* DATETIME */
};
// no return
Resources["EntityServices"].CreateApplicationKey(params);
//Get the generated Key's actual appKey value
var KeyID = ApplicationKeys["YOURKEYNAME"].GetKeyID();
|
|
Wenn Ablaufdatum nicht festgelegt ist, wird ein Wert aus dem Erstellungsdatum der Anwendungsschlüssel-Entität plus der Einstellung Anwendungsschlüssel-Lebensdauer (Sek.) im Untersystem der Benutzerverwaltung berechnet.
|
Anfängliche Anwendungsschlüsseleinrichtung und erste Verbindung – optimale Vorgehensweise
Geräte sollten möglichst immer in einer Entwicklungs-Sandbox online gehen oder in einer Entwicklungs-Sandbox simuliert werden. Sobald ein Gerät für die Produktion bereit ist, sollten neue Anwendungsschlüssel für jedes Gerät erstellt werden, das sich im Edge-Netzwerk der Anwendung befindet. Nachdem ein eindeutiger Anwendungsschlüssel erstellt und für das fragliche Gerät bereitgestellt wurde, sollte dieses Gerät überwacht werden, wenn es initialisiert wird, um zu verifizieren, ob es erfolgreich mit der Plattform verbunden wurde.
Anwendungsschlüsselablauf und -rotation
Als optimale Vorgehensweise sollten Anwendungsschlüssel ein begrenztes Ablaufdatum haben, das mit dem erwarteten Lebenszyklus des Geräts übereinstimmt, das die Anwendungsschlüssel-Anmeldeinformationen verwendet. Darüber hinaus wird nicht empfohlen, dass derselbe Anwendungsschlüssel für mehrere Geräte verwendet wird. Dies gilt insbesondere dann, wenn ihre Lebenszyklen unterschiedlich sind. Nachdem der Anwendungsschlüssel abgelaufen ist, sollte ein neuer Anwendungsschlüssel auf dem Gerät installiert werden.
Anwendungsschlüsselablauf für kritische Anwendungen
Wenn kein System für die Bereitstellung eines neuen Anwendungsschlüssels für das Gerät vorhanden ist, kann der Ablaufschlüssel auf dem Anwendungsschlüssel aktualisiert werden, um einen erweiterten Dienstlebenszyklus zu ermöglichen. Dies ist keine empfohlene optimale Vorgehensweise, kann jedoch als Workaround verwendet werden, wenn kritische Geschäftsdaten evtl. verloren gehen. Es ist wichtig, zu beachten, dass das Erweitern des Lebenszyklus des Anwendungsschlüssels über den erwarteten Lebenszyklus des Geräts hinaus zu Sicherheitsrisiken für die kritische Anwendungsinfrastruktur führen kann.
Verwandte Links