OAuths konfigurieren und laden
Bevor Sie einen OAuth-Konnektor für einen Dienst oder ein Dienstprogramm eines Drittanbieters erstellen, müssen Sie seinen OAuth-Anbieter auf den ThingWorx Flow Server laden. Die Beispiel-JSON-Dateivorlage für die OAuth-Konfiguration ist im oauthConfigurations Parameter des Diensts LoadOAuthConfiguration in ThingWorx Composer verfügbar. Im Folgenden finden Sie eine allgemeine Übersicht über den Prozess zum Laden von OAuths:
1. Erstellen Sie eine Anwendung im Drittanbieter-System.
2. Rufen Sie das Paar aus Client-ID und Client-Verschlüsselungswort aus der Anwendung ab, und fügen Sie es zur Beispiel-JSON-Datei für die OAuth-Konfiguration hinzu. Fügen Sie Werte aller zusätzlichen Parameter hinzu, die für die OAuth-Konfiguration erforderlich sind.
Um OAuth-Einstellungen für einen Dienst oder ein Dienstprogramm eines Drittanbieters zu entfernen, müssen Sie das gesamte JSON-Objekt entfernen. Um beispielsweise die OAuth-Einstellungen für Gmail zu entfernen, entfernen Sie das folgende JSON-Objekt:
"google_gmail": {
"Gmail": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},
Wenn Sie ein JSON-Objekt für einen Dienst oder ein Dienstprogramm eines Drittanbieters entfernt haben und die OAuth-Einstellungen später hinzufügen möchten, fügen Sie das JSON-Code-Snippet aus der Beispiel-JSON-Dateivorlage für die OAuth-Konfiguration hinzu, und geben Sie die erforderlichen Werte für die OAuth-Konfiguration an.
* 
Die Beispiel-Konfigurationsdatei enthält Konnektor-Konfigurationswerte, die den Dienst oder das Dienstprogramm eines Drittanbieters darstellen. Ändern Sie beispielsweise für Gmail nicht google_gmail im JSON-Objekt. Um mehrere OAuth-Anbieter für Gmail hinzuzufügen, z.B. Gmail-1 und Gmail-2, fügen Sie der Beispieldatei das folgende JSON-Objekt hinzu:
{
"google_gmail": {
"Gmail-1": {
"CLIENT_ID": "<client id for Gmail - 1 account here>",
"CLIENT_SECRET": "<client secret for Gmail - 1 account here>"
},
"Gmail-2": {
"CLIENT_ID": "<client id for Gmail - 2 account here>",
"CLIENT_SECRET": "<client secret for Gmail - 2 account here>"
}
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
In der folgenden Tabelle werden die Dienste und Dienstprogramme aufgeführt, für die ThingWorx Flow OAuth unterstützt, sowie ihre jeweiligen Konnektor-Konfigurationswerte:
Dienst oder Dienstprogramm
Konnektor-Konfigurationswert
azure
bitly
box
dropbox
dynamics365
excel
github
google_gmail
google_drive
google_form
google_sheet
google_task
google_translator
integrity
odata
microsoft_365
onedrive
salesforce
servicemax
slack
soap
swagger
trello
windchill
youtube
zendesk
OAuths für Dienste und Dienstprogramme konfigurieren und laden
Azure
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Azure-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Azure-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
API-Berechtigungen – Azure Service Management.
Umleitungs-URI – Geben Sie ThingWorx Flow die Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return ein.
2. Um einen OAuth-Anbieter für Azure hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Azure-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Azure-Anwendung ab.
"azure": {
"Azure": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Bitly
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Bitly-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Bitly-Anwendung.
Legen Sie bei der Erstellung der Anwendung die Umleitungs-URI auf eine ThingWorx Flow Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return fest.
2. Um einen OAuth-Anbieter für Bitly hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Bitly-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Bitly-Anwendung ab.
"bitly": {
"Bitly": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Box
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Box-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Box-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
Anwendungsumfänge – Wählen Sie alle Umfänge aus.
Umleitungs-URI – Geben Sie ThingWorx Flow die Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return ein.
Im folgenden Video werden die Schritte gezeigt, die erforderlich sind, um die OAuth-Konfiguration für Box zu aktivieren:
2. Um einen OAuth-Anbieter für Box hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Box-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Box-Anwendung ab.
"box": {
"Box": {
"CLIENT_SECRET": "client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Dropbox
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Dropbox-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Dropbox-Anwendung. Dieser Link enthält Informationen über Dropbox-OAuth.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
API – Wählen Sie Dropbox API aus.
Zugriffstyp – vollständiger Dropbox-Zugriff.
Umleitungs-URI – Geben Sie ThingWorx Flow die Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return ein.
2. Um einen OAuth-Anbieter für Dropbox hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Dropbox-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Dropbox-Anwendung ab.
"dropbox": {
"Dropbox": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Dynamics 365 CRM
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Dynamics 365 CRM-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Azure Active Directory-Anwendung.
Legen Sie bei der Erstellung der Anwendung die Umleitungs-URI auf eine ThingWorx Flow Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return fest.
2. Um einen OAuth-Anbieter für Dynamics 365 CRM hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Azure-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Azure-Anwendung ab.
"dynamics365": {
"Dynamics365": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Excel Online, Office 365, OneDrive
Führen Sie die folgenden Schritte aus, wenn Sie einen OAuth-Anbieter für eine Excel Online-, Office 365- oder OneDrive-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Azure-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
API-Berechtigungen – Azure Service Management.
Umleitungs-URI – Geben Sie ThingWorx Flow die Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return ein.
2. Um einen OAuth-Anbieter für Excel Online, Office 365 oder OneDrive hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Azure-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Azure-Anwendung ab.
Excel Online
"excel": {
"Excel Online": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Office 365
"microsoft_365": {
"Office 365": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
OneDrive
"onedrive": {
"OneDrive": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Github
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine GitHub-Anwendung hinzufügen möchten:
1. Erstellen Sie eine GitHub-OAuth-Anwendung.
Legen Sie beim Erstellen der Anwendung die Autorisierungs-Callback-URL auf eine ThingWorx Flow Rückgabe-URL im Format https://<Hostname:Port>/Thingworx/Oauths/oauth/return fest.
2. Um einen OAuth-Anbieter für Github hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Github-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Github-Anwendung ab.
"github": {
"Github": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Gmail, Google Drive, Google Forms, Google Sheets, Google Tasks, Google Übersetzer, YouTube
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Google-Anwendung hinzufügen möchten:
Geben Sie beim Konfigurieren der Anwendung den Umleitungs-URI als ThingWorx Flow Rückgabe-URL an, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für Ihre Google-Anwendung hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Google-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Google-Anwendung ab.
Gmail
"google_gmail": {
"Gmail": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Google Drive
"google_drive": {
"Google Drive": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Google Formulare
"google_form": {
"Google Form": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Google Tabellen
"google_sheet": {
"Google Sheet": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Google Tasks
"google_task": {
"Google Tasks": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Google Übersetzer
"google_translator": {
"Google Translator": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
YouTube
"youtube": {
"Youtube": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Integrity Lifecycle Manager
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen Integrity Lifecycle Manager Server hinzufügen möchten:
2. Geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an, um einen OAuth-Anbieter für Ihren Integrity Lifecycle Manager Server hinzuzufügen:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert von Ihrem PingFederate-OAuth-Client ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert von Ihrem PingFederate-OAuth-Client ab.
BASE_URL
Gibt PingFederate-OAuth-URL an.
https://<Pingfederate-FQDN>:<Port>/as
"integrity": {
"integrity": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"base_url": "<base url here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
OData
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für Ihre OData-Instanz hinzufügen möchten:
1. Konfigurieren Sie OAuth in Ihrer OData-Instanz.
2. Geben Sie in der JSON-Datei für die OAuth-Konfiguration Werte, die Ihrer OAuth-Konfiguration entsprechen, an. Siehe das Beispiel config.json. Nachfolgend werden Beispielwerte aufgeführt, die Sie für das Laden von OAuths angeben können:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
VALIDATE_URL
Gibt die URL an, die verwendet wird, um das Zugriffstoken zu validieren.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
REFRESH_URL
Gibt die URL an, die zum Abrufen von Zugriffstoken verwendet werden soll.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
TOKEN_URL
Stellt das Zugriffstoken bereit.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
AUTH_URL
Gibt den OAuth-Endpunkt für Token-Anforderungen an.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
Geben Sie Kopfzeileninformationen im Array "oauth2_validate_headers" an, wie im Beispiel-Array dargestellt:
{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}
Geben Sie Umfangsinformationen im Array "oauth2_params_scope" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
SOAP
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für Ihre SOAP-Instanz hinzufügen möchten:
1. Konfigurieren Sie OAuth in Ihrer SOAP-Instanz.
2. Geben Sie in der JSON-Datei für die OAuth-Konfiguration Werte, die Ihrer OAuth-Konfiguration entsprechen, an. Siehe das Beispiel config.json. Nachfolgend werden Beispielwerte aufgeführt, die Sie für das Laden von OAuths angeben können:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
VALIDATE_URL
Gibt die URL an, die verwendet wird, um das Zugriffstoken zu validieren.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
REFRESH_URL
Gibt die URL an, die zum Abrufen von Zugriffstoken verwendet werden soll.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
TOKEN_URL
Stellt das Zugriffstoken bereit.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
AUTH_URL
Gibt den OAuth-Endpunkt für Token-Anforderungen an.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
Geben Sie Kopfzeileninformationen im Array "oauth2_validate_headers" an, wie im Beispiel-Array dargestellt:
{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}
Geben Sie Umfangsinformationen im Array "oauth2_params_scope" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Salesforce
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Salesforce-Anwendung hinzufügen möchten:
1. Erstellen Sie eine Salesforce-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
Umfänge – Stellen Sie der Anwendung entsprechende Umfänge zur Verfügung.
Callback-URL – Geben Sie die ThingWorx Flow Rückgabe-URL ein, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für Salesforce hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Salesforce-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Salesforce-Anwendung ab.
"salesforce": {
"Salesforce": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Im folgenden Video werden die Schritte gezeigt, die erforderlich sind, um die OAuth-Konfiguration für Salesforce zu aktivieren:
Servicemax
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine ServiceMax-Anwendung hinzufügen möchten:
1. Nachdem Sie sich bei ServiceMaxangemeldet haben, erstellen Sie eine ServiceMax-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
Umfänge – Stellen Sie der Anwendung entsprechende Umfänge zur Verfügung.
Callback-URL – Geben Sie die ThingWorx Flow Rückgabe-URL ein, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für Servicemax hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Servicemax-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Servicemax-Anwendung ab.
"servicemax": {
"Servicemax": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Slack
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Slack-Anwendung hinzufügen möchten:
1. Erstellen Sie Ihre Slack-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
Umfänge – Stellen Sie der Anwendung entsprechende Umfänge zur Verfügung.
Umleitungs-URL – Geben Sie die ThingWorx Flow Rückgabe-URL ein, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für Slack hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Slack-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Slack-Anwendung ab.
"slack": {
"Slack": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Swagger
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für Ihre Swagger-Instanz hinzufügen möchten:
1. Konfigurieren Sie OAuth in Ihrer Swagger-Instanz.
2. Geben Sie in der JSON-Datei für die OAuth-Konfiguration Werte, die Ihrer OAuth-Konfiguration entsprechen, an. Siehe das Beispiel config.json. Nachfolgend werden Beispielwerte aufgeführt, die Sie für das Laden von OAuths angeben können:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der OAuth-Anwendung ab.
VALIDATE_URL
Gibt die URL an, die verwendet wird, um das Zugriffstoken zu validieren.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
REFRESH_URL
Gibt die URL an, die zum Abrufen von Zugriffstoken verwendet werden soll.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
TOKEN_URL
Stellt das Zugriffstoken bereit.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
AUTH_URL
Gibt den OAuth-Endpunkt für Token-Anforderungen an.
Rufen Sie den Wert von Ihrem OAuth-Client ab.
Geben Sie Kopfzeileninformationen im Array "oauth2_validate_headers" an, wie im Beispiel-Array dargestellt:
{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}
Geben Sie Umfangsinformationen im Array "oauth2_params_scope" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Trello
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für ein Trello-Konto hinzufügen möchten:
1. Erstellen Sie ein Trello-Entwicklerkonto und ein Trello-Konto.
Legen Sie in den Einstellungen die entsprechenden Werte für den folgenden Parameter fest:
Umleitungs-URL – Geben Sie die ThingWorx Flow Rückgabe-URL unter Allowed Origins ein, z.B. https://<HostName:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für Trello hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CONSUMER_KEY
Gibt den Verbraucherschlüssel für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus den API-Schlüsseln des Trello-Entwicklers ab.
CONSUMER_SECRET
Wert des Verbraucher-Verschlüsselungsworts.
Rufen Sie den Wert aus den API-Schlüsseln des Trello-Entwicklers ab.
"trello": {
"Trello": {
"CONSUMER_SECRET": "<client secret here>",
"CONSUMER_KEY": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Windchill
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen Windchill Server hinzufügen möchten:
2. Um einen OAuth-Anbieter für Windchill hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert von Ihrem PingFederate-OAuth-Client ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert von Ihrem PingFederate-OAuth-Client ab.
BASE_URL
Gibt PingFederate-OAuth-URL an.
https://<Pingfederate-FQDN>:<Port>/as
PF_IDP_ADAPTER_ID
Optional. Gibt die Adapter-ID für den PingFederate-IdP aus Ihrer Konfiguration an. Geben Sie diese nur an, wenn Sie mehrere IDP-Adapter in PingFederate haben.
PingFederateAdapterID
RESOURCE_URL
Optional. Gibt die Windchill URL an.
Es wird empfohlen, RESOURCE_URL während der Konfiguration von OAuth anzugeben. Wenn Sie RESOURCE_URL nicht angeben, muss der Benutzer sie beim Hinzufügen eines OAuth-Konnektors angeben.
<Protokoll>://<Windchill FQDN>:<Port>/Windchill
"windchill": {
"Windchill": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"base_url": "<base url here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Zendesk
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Zendesk-Anwendung hinzufügen möchten:
1. Erstellen Sie Ihre Zendesk-Anwendung.
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
Umfänge – Stellen Sie der Anwendung entsprechende Umfänge zur Verfügung.
Umleitungs-URL – Geben Sie die ThingWorx Flow Rückgabe-URL ein, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
Im folgenden Video werden die Schritte gezeigt, die erforderlich sind, um die OAuth-Konfiguration für Zendesk zu aktivieren:
2. Um einen OAuth-Anbieter für Zendesk hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter
Beschreibung
Wert
CLIENT_ID
Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an.
Rufen Sie den Wert aus der Zendesk-Anwendung ab.
CLIENT_SECRET
Client-Geheimnis.
Rufen Sie den Wert aus der Zendesk-Anwendung ab.
"zendesk": {
"Zendesk": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
3. Führen Sie den LoadOAuthConfiguration-Dienst aus ThingWorx Composer aus, um den OAuth-Anbieter auf den ThingWorx Flow Server zu laden.
Problembehandlung
Szenario
Lösung
Ein OAuth-Anbieter kann nicht hinzugefügt werden, wenn ein OAuth-Konnektor einen vorhandenen OAuth-Anbieter mit dem gleichen Namen verwendet.
* 
Alle anderen gültigen OAuth-Anbieter, die in der JSON-Datei vorhanden sind, werden nicht hochgeladen.
Fügen Sie einen eindeutigen OAuth-Anbieternamen hinzu, und laden Sie dann die OAuth-Konfiguration.
Wenn beispielsweise Gmail-1 bereits in der OAuth-Konfiguration vorhanden ist, fügen Sie der JSON-Datei für die OAuth-Konfiguration Gmail-2 hinzu, wie im folgenden Beispielcode dargestellt:
{
"google_gmail": {
"Gmail-1": {
"CLIENT_ID": "<client id for Gmail - 1 account here>",
"CLIENT_SECRET": "<client secret for Gmail - 1 account here>"
},
"Gmail-2": {
"CLIENT_ID": "<client id for Gmail - 2 account here>",
"CLIENT_SECRET": "<client secret for Gmail - 2 account here>"
}
}
}
ODER
Löschen Sie alle Konnektoren, die den vorhandenen OAuth-Anbieter verwenden, laden Sie den OAuth-Anbieter erneut hoch, und starten Sie dann den OAuth-Dienst neu.
Führen Sie die folgenden Schritte aus, um den OAuth-Dienst neu zu starten:
1. Starten Sie auf dem System, auf dem ThingWorx Flow installiert ist, eine Eingabeaufforderung als Administrator.
2. Führen Sie den Befehl pm2 ls aus, um die OAuth-Dienstnummer abzurufen.
3. Führen Sie den Befehl pm2 restart <OAuth_Dienstnummer> aus, um den OAuth-Server neu zu starten.
ODER
Starten Sie auf dem System, auf dem ThingWorx Flow installiert ist, eine Eingabeaufforderung als Administrator, und führen Sie den Befehl pm2 restart flow-oauth-server aus, um den OAuth-Server neu zu starten.