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 Parameter oauthConfigurations des Dienstes LoadOAuthConfiguration von WorkflowSubsystem 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>" } } }
|
ThingWorx Flow unterstützt OAuth für die folgenden Dienste und Dienstprogramme:
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:
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>"
}
}
Bitly
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Bitly-Anwendung hinzufügen möchten:
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>"
}
}
Box
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Box-Anwendung hinzufügen möchten:
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>"
}
}
Dialogflow
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Dialogflow-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.
Um einen OAuth-Anbieter für Ihre Dialogflow-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. |
"apiai": {
"Dialogflow": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
Dropbox
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Dropbox-Anwendung hinzufügen möchten:
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>"
}
}
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:
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>"
}
}
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:
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>" } } |
Github
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine GitHub-Anwendung hinzufügen möchten:
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>"
}
}
Gitlab
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Gitlab-Anwendung hinzufügen möchten:
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
▪ Umfänge – api, read_user, read_repository, read_registry.
▪ Umleitungs-URI – Geben Sie ThingWorx Flow die Rückgabe-URL wie https://<Hostname:Port>/Thingworx/Oauths/oauth/return ein.
2. Um einen OAuth-Anbieter für Gitlab 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 Gitlab-Anwendung ab. |
CLIENT_SECRET | Client-Geheimnis. | Rufen Sie den Wert aus der Gitlab-Anwendung ab. |
"gitlab": {
"Gitlab": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
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.
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>" } } | |
HTTP
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen HTTP-Server hinzufügen möchten:
1. Konfigurieren Sie OAuth auf Ihrem HTTP-Server.
2. Um einen OAuth-Anbieter für Ihren HTTP-Server hinzuzufügen, geben Sie die folgenden Werte in der JSON-Datei für die OAuth-Konfiguration an:
Parameter | Beschreibung | Wert |
---|
AUTH_URL [Erforderlich] | Gibt den OAuth-Endpunkt für Token-Anforderungen an. | Rufen Sie den Wert von Ihrem OAuth-Client ab. Beispiel: \authorize |
TOKEN_URL [Erforderlich] | Stellt das Zugriffstoken bereit. | Rufen Sie den Wert von Ihrem OAuth-Client ab. Beispiel: \token |
VALIDATE_URL [Erforderlich] | Gibt die URL an, die verwendet wird, um das Zugriffstoken zu validieren. | Rufen Sie den Wert von Ihrem OAuth-Client ab. • Soll VALIDATE_URL nicht ausgeführt werden, so müssen Sie eine , geben Sie die zugängliche Server-URL angeben. Beispiel: https://www.dropbox.com/ • Verwenden Sie die get-Methode zum Erstellen der API, wenn Sie VALIDATE_URL implementieren möchten |
REFRESH_URL | Gibt die URL an, die zum Abrufen von Zugriffstoken verwendet werden soll. | Rufen Sie den Wert von Ihrem OAuth-Client ab. Beispiel: \token |
SCOPE [Erforderlich] | Stellt eine durch Leerzeichen getrennte Liste von Bereichen für Ihre Anwendung bereit. | <UMFANG 1> <UMFANG 2> |
BASE_URL [Erforderlich] | Gibt die URL des Central Auth Server an. | Rufen Sie den Wert von Ihrem OAuth-Client ab. |
NEED_RESOURCE_URL [Erforderlich] | Gibt an, ob der Benutzer beim Hinzufügen des OAuth-Konnektors RESOURCE_URL angeben muss. Wenn Sie diese Einstellung auf Wahrfestlegen, müssen Sie den Wert für RESOURCE_URL beim Hinzufügen des OAuth-Anbieters angeben. Wenn Sie diese Einstellung auf Falschfestlegen, müssen Sie den Wert für RESOURCE_URL beim Hinzufügen des OAuth-Konnektors angeben. | wahr oder false |
RESOURCE_URL | Gibt die Ressourcenserver-URL an. | – |
CLIENT_ID [Erforderlich] | Gibt die Client-ID für die Validierung von Zugriffs-Token vom Autorisierungsserver an. | Rufen Sie den Wert von Ihrem OAuth-Client ab. |
CLIENT_SECRET [Erforderlich] | Client-Geheimnis. | Rufen Sie den Wert von Ihrem OAuth-Client ab. |
"devtools": {
"HTTP": {
"AUTH_URL": "<auth url here>",
"CLIENT_SECRET": "<client secret here>",
"TOKEN_URL": "<token url here>",
"VALIDATE_URL": "<validate url here>",
"CLIENT_ID": "<client id here>",
"SCOPE": "<scopes separated by spaces>",
"RESOURCE_URL": "<resource url here>",
"BASE_URL": "<base url here>",
"REFRESH_URL": "<refresh url here>",
"NEED_RESOURCE_URL": "<boolean value here>"
}
}
JIRA
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine JIRA-Anwendung hinzufügen möchten:
Legen Sie beim Erstellen der Anwendung die entsprechenden Werte der folgenden Parameter fest:
▪ Umfänge – view Jira issue data (read:jira-work), create and manage issues (write:jira-work), view user profiles (read:jira-user)
▪ 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 JIRA 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 JIRA-Anwendung ab. |
CLIENT_SECRET | Client-Geheimnis. | Rufen Sie den Wert aus der JIRA-Anwendung ab. |
"jira": {
"JIRA": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}
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. |
{
"name": "odata",
"created_at": "2017-02-27T09:26:46.890Z",
"updated_at": "2017-02-27T09:26:46.890Z",
"uid": "oaufe1978bc9e71d999ef2ba4",
"icon": "odata",
"version": "v1",
"__v": 0,
"title": "Dynamics 365",
"oauth2_include": [
"{\"resource\":\"{resource}\"}"
],
"oauth2_required": [
{
"title": "Tenant ID",
"id": "tenant",
"default": "common",
"description": "Enter Dynamics 365 tenant id, leave it common if you don't have it"
},
{
"title": "Resource URL",
"id": "resource",
"description": "Enter Dynamics 365 resource URL, eg: https://example.crm5.dynamics.com"
}
],
"oauth2_params_scope": [
"{\"user_impersonation\":\"User Impersonation\"}"
],
"oauth2_refresh_data": [
"{\"client_secret\":\"{client_secret}\"}",
"{\"grant_type\":\"refresh_token\"}",
"{\"client_id\":\"{client_id}\"}",
"{\"resource\":\"{resource}\"}",
"{\"refresh_token\":\"{refresh_token}\"}"
],
"oauth2_refresh_url": "/token",
"oauth2_token_data": [
"{\"redirect_uri\":\"{redirect_uri}\"}",
"{\"client_id\":\"{client_id}\"}",
"{\"client_secret\":\"{client_secret}\"}",
"{\"resource\":\"{resource}\"}",
"{\"grant_type\":\"authorization_code\"}"
],
"oauth2_token_url": "/token",
"oauth2_auth_query": [
"{\"client_id\":\"{client_id}\"}",
"{\"response_type\":\"code\"}",
"{\"resource\":\"{resource}\"}",
"{\"scope\":\"{scope}\"}",
"{\"prompt\":\"login\"}",
"{\"redirect_uri\":\"{redirect_uri}\"}"
],
"oauth2_auth_url": "/authorize",
"oauth2_no_state": false,
"env_pre_prod_params": [
"{\"client_secret\":\"{{{pre_prod.CLIENT_SECRET}}}\"}",
"{\"redirect_uri\":\"{OAUTH_ENDPOINT_OAUTH_RETURN}\"}"
],
"env_production_params": [
"{\"redirect_uri\":\"{OAUTH_ENDPOINT_OAUTH_RETURN}\"}",
"{\"client_id\":\"{{{production.CLIENT_ID}}}\"}",
"{\"client_secret\":\"{{{production.CLIENT_SECRET}}}\"}"
],
"env_staging_params": [
"{\"redirect_uri\":\"{OAUTH_ENDPOINT_OAUTH_RETURN}\"}",
"{\"client_id\":\"{{{staging.CLIENT_ID}}}\"}",
"{\"client_secret\":\"{{{staging.CLIENT_SECRET}}}\"}"
],
"env_development_params": [
"{\"client_id\":\"{{{development.CLIENT_ID}}}\"}",
"{\"client_secret\":\"{{{development.CLIENT_SECRET}}}\"}",
"{\"redirect_uri\":\"{OAUTH_ENDPOINT_OAUTH_RETURN}\"}"
],
"env_local_params": [
"{\"client_id\":\"{{{local.CLIENT_ID}}}\"}",
"{\"client_secret\":\"{{{local.CLIENT_SECRET}}}\"}",
],
"base_url": "https://login.microsoftonline.com/{tenant}/oauth2",
"oauth_type": "OAuth2",
"development_phase": "new",
"advanced_enabled": true,
"express_enabled": true,
"deleted_at": null,
"published": true
}
▪ 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\"}"
]
}
▪ Geben Sie needurl-Informationen im Array "oauth2_params_other" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}
OSLC
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für Ihren OSLC-Server hinzufügen möchten:
2. Um einen OAuth-Anbieter für OSLC 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 OAuth-Client ab. |
CLIENT_SECRET | Client-Geheimnis. | Rufen Sie den Wert von Ihrem OAuth-Client ab. |
BASE_URL | Gibt die OAuth-URL an. | Rufen Sie den Wert von Ihrem Central Auth Server ab. Wenn Ihr OAuth-Client PingFederate ist, muss diese URL das folgende Format aufweisen: https://<Pingfederate-FQDN>:<Port>/as |
VALIDATE_URL | Gibt die URL an, die verwendet wird, um das Zugriffstoken zu validieren. | Rufen Sie den Wert von Ihrem Central Auth Server ab. Beispiel:/introspect.oauth2 |
RESOURCE_URL | Gibt die OSLC-Server-URL an. Wenn Sie RESOURCE_URL nicht angeben, müssen Sie die Werte für OAUTH_URL, REFRESH_URL und TOKEN_URL angeben. | Rufen Sie den Wert von Ihrem Central Auth Server ab. |
OAUTH_URL | Gibt den OAuth-Endpunkt für Token-Anforderungen an. | Rufen Sie den Wert von Ihrem Central Auth Server ab. Beispiel:/authorization.oauth2 |
REFRESH_URL | Gibt die URL an, die zum Abrufen von Zugriffstoken verwendet werden soll. | Rufen Sie den Wert von Ihrem Central Auth Server ab. Beispiel:/token.oauth2 |
TOKEN_URL | Stellt das Zugriffstoken bereit. | Rufen Sie den Wert von Ihrem Central Auth Server ab. Beispiel:/token.oauth2 |
"oslc": {
"OSLC": {
"CLIENT_SECRET": "<client secret here>",
"OAUTH_URL": "<oauth url here>",
"VALIDATE_URL": "<validate url here>",
"VALIDATE_AUTH": "<stringified validate auth object here in format <auth>:<authObject>, authObject should be a stringified json object>",
"TOKEN_URL": "<token url here>",
"CLIENT_ID": "client id here>",
"RESOURCE_URL": "<resource url here>",
"VALIDATE_QUERY": "<stringified validate query object here in format <token>:<access_token>",
"BASE_URL": "<base url here>",
"VALIDATE_METHOD": "<validate method here>",
"REFRESH_URL": "<refresh url here>"
}
}
| Sie müssen entweder RESOURCE_URL oder die Autorisierungsparameter (OAUTH_URL, REFRESH_URL und TOKEN_URL) angeben. |
SAP OData
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen SAP OData-Server hinzufügen möchten:
Stellen Sie beim Konfigurieren von OAuth die Umleitungs-URI als ThingWorx Flow Rückgabe-URL bereit, z.B. https://<Hostname:Port>/Thingworx/Oauths/oauth/return.
2. Um einen OAuth-Anbieter für SAP OData 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 SAP-OAuth-Client ab. |
CLIENT_SECRET | Client-Geheimnis. | Rufen Sie den Wert von Ihrem SAP-OAuth-Client ab. |
BASE_URL | Gibt die zentrale Autorisierungsserver-URL an. | https://<Hostname:Port>/sap/bc/sec/oauth2 |
SCOPE | Durch Leerzeichen getrennte Liste von Umfängen. Weitere Informationen finden Sie unter OAuth-Umfänge. | <UMFANG 1> <UMFANG 2> |
RESOURCE_URL | Gibt die SAP-Ressourcen-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. | https://<Host:Port>/ |
"sap_odata": {
"SAP_OData": {
"CONNECTION_URL": "<SAP OData url in format https://<host>:<port>/>",
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"SCOPE": "<scopes separated by space>",
"BASE_URL": "<SAP OAuth url in format https://<host>:<port>/sap/bc/sec/oauth2>"
}
}
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\"}"
]
}
▪ Geben Sie needurl-Informationen im Array "oauth2_params_other" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}
Salesforce
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Salesforce-Anwendung hinzufügen möchten:
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>"
}
}
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:
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>"
}
}
Slack
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Slack-Anwendung hinzufügen möchten:
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>"
}
}
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\"}"
]
}
▪ Geben Sie needurl-Informationen im Array "oauth2_params_other" an, wie im Beispiel-Array dargestellt:
{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}
ThingWorx
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen ThingWorx Server hinzufügen möchten:
2. Um einen OAuth-Anbieter für ThingWorx 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 |
RESOURCE_URL | Gibt die ThingWorx 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. | https://<Thingworx FQDN>:<Port>/Thingworx |
"thingworx": {
"Thingworx": {
"CLIENT_SECRET": "client secret here>",
"CLIENT_ID": "client id here>",
"RESOURCE_URL": "<Thingworx URL in format https://<Thingworx FQDN>:<port>/Thingworx>",
"BASE_URL": "<Pingfederate URL in format https://<Pingfederate FQDN>:<port>/as>"
}
}
Trello
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für ein Trello-Konto hinzufügen möchten:
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. | |
CONSUMER_SECRET | Wert des Verbraucher-Verschlüsselungsworts. | |
"trello": {
"Trello": {
"CONSUMER_SECRET": "<client secret here>",
"CONSUMER_KEY": "<client id here>"
}
}
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 |
SCOPE | Schränkt den Zugriff der Anwendung auf das Konto eines Benutzers ein, indem Zugriffs-Token auf Grundlage der gewährten Bereiche ausgegeben werden. Trennen Sie die Bereiche durch ein Komma (,), um mehrere Bereiche hinzuzufügen. | WINDCHILL_READ, <scope1>, <scope2> |
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>"
}
}
Windchill RV&S
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für einen Windchill RV&S Server hinzufügen möchten:
2. Um einen OAuth-Anbieter für Windchill RV&S 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 |
"integrity": {
"integrity": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"base_url": "<base url here>"
}
}
Zendesk
Führen Sie die folgenden Schritte jedes Mal aus, wenn Sie einen OAuth-Anbieter für eine Zendesk-Anwendung hinzufügen möchten:
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>"
}
}
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: a. Starten Sie auf dem System, auf dem ThingWorx Flow installiert ist, eine Eingabeaufforderung als Administrator. b. Führen Sie den Befehl pm2 ls aus, um die OAuth-Dienstnummer abzurufen. c. 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. |