Configuration et chargement d'OAuths

ThingWorx Flow > Installation et configuration > Configuration de ThingWorx Flow > Configuration et chargement d'OAuths

Avant de créer un connecteur OAuth pour un service ou un utilitaire tiers, vous devez charger son fournisseur OAuth sur le serveur ThingWorx Flow. L'exemple de modèle de fichier JSON de configuration OAuth est disponible dans le paramètre oauthConfigurations du service LoadOAuthConfiguration du WorkflowSubsystem de ThingWorx Composer. Vous trouverez ci-après une vue d'ensemble du processus de chargement d'OAuths :

1. Créez une application sur le système tiers.

2. Récupérez la paire ID/clé secrète client dans l'application et ajoutez-la au modèle de fichier JSON de configuration OAuth. Ajoutez les valeurs des paramètres supplémentaires requis pour la configuration OAuth.

Pour supprimer les paramètres OAuth d'un service ou d'un utilitaire tiers, vous devez supprimer l'intégralité de son objet JSON. Par exemple, pour supprimer les paramètres OAuth de Gmail, supprimez l'objet JSON suivant :

"google_gmail": {
"Gmail": {
"CLIENT_ID": "<Client ID>"
"CLIENT_SECRET": "<Secret>"
}
},

Si vous avez supprimé un objet JSON pour un service ou un utilitaire tiers et que vous souhaitez ultérieurement rajouter ses paramètres OAuth, récupérez l'extrait de code JSON approprié depuis le modèle de fichier JSON de configuration OAuth, et fournissez les valeurs requises pour la configuration OAuth.

Le modèle de fichier de configuration contient des valeurs de configuration de connecteur qui représentent le service ou l'utilitaire tiers. Par exemple, pour Gmail, ne modifiez pas google_gmail dans l'objet JSON. Pour ajouter plusieurs fournisseurs OAuth pour Gmail, par exemple, Gmail-1 et Gmail-2, ajoutez l'objet JSON suivant dans le fichier modèle :

{
"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. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

ThingWorx Flow prend en charge OAuth pour les services et utilitaires suivants :

• Azure

• Bitly

• Box

• Dialogflow

• Dropbox

• Dynamics 365 CRM

• Excel Online

• Github

• Gitlab

• Gmail

• Google Drive

• Google Forms

• Google Sheets

• Google Tasks

• Google Translator

• HTTP

• JIRA

• OData

• OSLC

• Office 365

• OneDrive

• OData SAP

• SOAP

• Salesforce

• ServiceMax

• Slack

• Swagger

• ThingWorx

• Trello

• Windchill

• Windchill RV&S

• YouTube

• Zendesk

Configuration et chargement d'OAuths pour les services et utilitaires

Azure

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Azure :

1. Créez une application Azure.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ API Permissions : gestion des services Azure.

▪ Redirect URI : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Azure, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Azure.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Azure.

"azure": {
"Azure": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Bitly

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Bitly :

1. Créez une application Bitly.

Lors de la création de l'application, définissez l'URI de redirection sur une URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Bitly, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Bitly.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Bitly.

"bitly": {
"Bitly": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Box

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Box :

1. Créez une application Box.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Application Scopes : sélectionnez toutes les étendues.

▪ Redirect URI : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

La vidéo suivante montre les étapes à suivre pour activer la configuration OAuth pour Box :

2. Pour ajouter un fournisseur OAuth pour Box, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Box.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Box.

"box": {
"Box": {
"CLIENT_SECRET": "client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Dialogflow

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Dialogflow :

1. Configurez OAuth pour votre projet Dialogflow.

Lors de la création de l'app, spécifiez l'URI de redirection sous la forme d'une URL de renvoi ThingWorx Flow, au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

Pour ajouter un fournisseur OAuth pour votre application Dialogflow, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Google.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Google.

"apiai": {
"Dialogflow": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

2. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Dropbox

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Dropbox :

1. Créez une application Dropbox. Ce lien fournit des informations sur le processus OAuth de Dropbox.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ API : sélectionnez l'API Dropbox.

▪ Type of access : Dropbox complet.

▪ Redirect URI : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Dropbox, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Dropbox.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Dropbox.

"dropbox": {
"Dropbox": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Dynamics 365 CRM

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Dynamics 365 CRM :

1. Créez une application Azure Active Directory.

Lors de la création de l'application, définissez l'URI de redirection sur une URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Dynamics 365 CRM, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Azure.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Azure.

"dynamics365": {
"Dynamics365": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Excel Online, Office 365, OneDrive

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Excel Online, Office 365 ou OneDrive :

1. Créez une application Azure.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ API Permissions : gestion des services Azure.

▪ Redirect URI : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Excel Online, Office 365 ou OneDrive, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Azure.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Azure.

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. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

GitHub

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application GitHub :

1. Créez une application OAuth GitHub.

Lors de la création de l'application, définissez l'URL de rappel sur une URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour GitHub, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application GitHub.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application GitHub.

"github": {
"Github": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

GitLab

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application GitLab :

1. Créez une application GitLab.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : api, read_user, read_repository, read_registry.

▪ Redirect URI : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour GitLab, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application GitLab.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application GitLab.

"gitlab": {
"Gitlab": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Gmail, Google Drive, Google Forms, Google Sheets, Google Tasks, Google Translator, YouTube

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Google :

1. Configurez OAuth pour votre application Google.

Lors de la création de l'app, spécifiez l'URI de redirection sous la forme d'une URL de renvoi ThingWorx Flow, au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

Pour ajouter un fournisseur OAuth pour votre application Google, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Google.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Google.

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 Form "google_form": { "Google Form": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }	Google Sheet "google_sheet": { "Google Sheet": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }
Google Task "google_task": { "Google Tasks": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }	Google Translator "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>" } }

2. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

HTTP

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un serveur HTTP :

1. Configurez OAuth sur votre serveur HTTP.

2. Pour ajouter un fournisseur OAuth pour votre serveur HTTP, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
AUTH_URL [obligatoire]	Spécifie le point de terminaison OAuth pour les demandes de jeton.	Récupérez la valeur dans votre client OAuth. Exemple : \authorize
TOKEN_URL [obligatoire]	Fournit le jeton d'accès.	Récupérez la valeur dans votre client OAuth. Exemple : \token
VALIDATE_URL [obligatoire]	Spécifie l'URL utilisée pour valider le jeton d'accès.	Récupérez la valeur dans votre client OAuth. • Si vous ne voulez pas VALIDATE_URL, spécifiez l'URL du serveur accessible. Exemple : https://www.dropbox.com/ • Si vous souhaitez implémenter VALIDATE_URL, utilisez la méthode get pour créer une API.
REFRESH_URL	Spécifie l'URL à utiliser pour obtenir des jetons d'accès.	Récupérez la valeur dans votre client OAuth. Exemple : \token
SCOPE [obligatoire]	Fournit une liste d'étendues séparées par des espaces pour votre application.	<ETENDUE 1> <ETENDUE 2>
BASE_URL [obligatoire]	Spécifie l'URL du serveur d'autorisation central.	Récupérez la valeur dans votre client OAuth.
NEED_RESOURCE_URL [obligatoire]	Indique si l'utilisateur doit fournir le paramètre RESOURCE_URL pendant l'ajout du connecteur OAuth. Si vous définissez cette propriété sur Vrai, vous devez spécifier la valeur du paramètre RESOURCE_URL pendant l'ajout du connecteur OAuth. Si vous définissez cette propriété sur Faux, vous devez spécifier la valeur du paramètre RESOURCE_URL pendant l'ajout du connecteur OAuth.	vrai ou faux
RESOURCE_URL	Spécifie l'URL du serveur de ressources.	—
CLIENT_ID [obligatoire]	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth.
CLIENT_SECRET [obligatoire]	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth.

"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>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

JIRA

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application JIRA :

1. Créez une application JIRA.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : view Jira issue data (read:jira-work), create and manage issues (write:jira-work), view user profiles (read:jira-user)

▪ Callback URL : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour JIRA, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application JIRA.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application JIRA.

"jira": {
"JIRA": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

OData

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour votre instance OData :

1. Configurez OAuth sur votre instance OData.

2. En fonction de votre configuration OAuth, fournissez des valeurs dans le fichier JSON de configuration OAuth. Reportez-vous à exemple config.json. Voici des exemples de valeurs que vous pouvez spécifier pour le chargement d'OAuths :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application OAuth.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application OAuth.
VALIDATE_URL	Spécifie l'URL utilisée pour valider le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
REFRESH_URL	Spécifie l'URL à utiliser pour obtenir des jetons d'accès.	Récupérez la valeur dans votre client OAuth.
TOKEN_URL	Fournit le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
AUTH_URL	Spécifie le point de terminaison OAuth pour les demandes de jeton.	Récupérez la valeur dans votre client OAuth.

{
"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
}

▪ Spécifiez les informations d'en-tête dans le tableau "oauth2_validate_headers", comme illustré dans l'exemple de tableau :

{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}

▪ Spécifiez les informations d'étendue dans le tableau "oauth2_params_scope", comme illustré dans l'exemple de tableau :

{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}

▪ Spécifiez les informations needurl dans le tableau "oauth2_params_other", comme illustré dans l'exemple de tableau :

{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

OSLC

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour votre serveur OSLC :

1. Configurez les paramètres OAuth sur le serveur OSLC.

2. Pour ajouter un fournisseur OAuth pour OSLC, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth.
BASE_URL	Spécifie l'URL de l'OAuth.	Récupérez la valeur auprès du serveur d'autorisation central. Si votre client OAuth est PingFederate, cette URL doit être au format suivant : https://<FQDN Pingfederate>:<Port>/as
VALIDATE_URL	Spécifie l'URL utilisée pour valider le jeton d'accès.	Récupérez la valeur auprès du serveur d'autorisation central. Exemple : /introspect.oauth2
RESOURCE_URL	Spécifie l'URL du serveur OSLC. Si vous ne spécifiez pas le paramètre RESOURCE_URL, vous devez indiquer les valeurs de OAUTH_URL, REFRESH_URL et TOKEN_URL.	Récupérez la valeur auprès du serveur d'autorisation central.
OAUTH_URL	Spécifie le point de terminaison OAuth pour les demandes de jeton.	Récupérez la valeur auprès du serveur d'autorisation central. Exemple : /authorization.oauth2
REFRESH_URL	Spécifie l'URL à utiliser pour obtenir des jetons d'accès.	Récupérez la valeur auprès du serveur d'autorisation central. Exemple : /token.oauth2
TOKEN_URL	Fournit le jeton d'accès.	Récupérez la valeur auprès du serveur d'autorisation central. Exemple : /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>"
}
}

Vous devez spécifier soit le paramètre RESOURCE_URL, soit les paramètres d'autorisation (OAUTH_URL, REFRESH_URL et TOKEN_URL).

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

OData SAP

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un serveur OData SAP :

1. Configurez les paramètres OAuth sur le serveur SAP.

Lors de la configuration des paramètres OAuth, spécifiez l'URI de redirection sous la forme d'une URL de renvoi ThingWorx Flow, au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour OData SAP, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth SAP.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth SAP.
BASE_URL	Spécifie l'URL du serveur d'autorisation central.	https://<NomHôte:Port>/sap/bc/sec/oauth2
SCOPE	Liste d'étendues séparées par des espaces. Pour plus d'informations, reportez-vous à cette page sur les étendues OAuth (en anglais).	<ETENDUE 1> <ETENDUE 2>
RESOURCE_URL	Spécifie l'URL de la ressource SAP. Il est recommandé de fournir la RESOURCE_URL lors de la configuration de l'OAuth. Si vous ne spécifiez pas la RESOURCE_URL, l'utilisateur devra la fournir lors de l'ajout d'un connecteur OAuth.	https://<Hôte: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>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

SOAP

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour votre instance SOAP :

1. Configurez OAuth sur votre instance SOAP.

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application OAuth.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application OAuth.
VALIDATE_URL	Spécifie l'URL utilisée pour valider le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
REFRESH_URL	Spécifie l'URL à utiliser pour obtenir des jetons d'accès.	Récupérez la valeur dans votre client OAuth.
TOKEN_URL	Fournit le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
AUTH_URL	Spécifie le point de terminaison OAuth pour les demandes de jeton.	Récupérez la valeur dans votre client OAuth.

▪ Spécifiez les informations d'en-tête dans le tableau "oauth2_validate_headers", comme illustré dans l'exemple de tableau :

{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}

▪ Spécifiez les informations d'étendue dans le tableau "oauth2_params_scope", comme illustré dans l'exemple de tableau :

{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}

▪ Spécifiez les informations needurl dans le tableau "oauth2_params_other", comme illustré dans l'exemple de tableau :

{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Salesforce

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Salesforce :

1. Créez une application Salesforce.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : définissez les étendues appropriées pour l'application.

▪ Callback URL : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Salesforce, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Salesforce.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Salesforce.

"salesforce": {
"Salesforce": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

La vidéo suivante montre les étapes à suivre pour activer la configuration OAuth pour Salesforce :

ServiceMax

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application ServiceMax :

1. Après vous être connecté à ServiceMax, créez une application ServiceMax.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : définissez les étendues appropriées pour l'application.

▪ Callback URL : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour ServiceMax, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application ServiceMax.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application ServiceMax.

"servicemax": {
"Servicemax": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Slack

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Slack :

1. Créez votre application Slack.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : définissez les étendues appropriées pour l'application.

▪ Redirect URL : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Slack, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Slack.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Slack.

"slack": {
"Slack": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Swagger

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour votre instance Swagger :

1. Configurez OAuth sur votre instance Swagger.

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application OAuth.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application OAuth.
VALIDATE_URL	Spécifie l'URL utilisée pour valider le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
REFRESH_URL	Spécifie l'URL à utiliser pour obtenir des jetons d'accès.	Récupérez la valeur dans votre client OAuth.
TOKEN_URL	Fournit le jeton d'accès.	Récupérez la valeur dans votre client OAuth.
AUTH_URL	Spécifie le point de terminaison OAuth pour les demandes de jeton.	Récupérez la valeur dans votre client OAuth.

▪ Spécifiez les informations d'en-tête dans le tableau "oauth2_validate_headers", comme illustré dans l'exemple de tableau :

{
"oauth2_validate_headers": [
"{\"Authorization\":\"Bearer {access_token}\"}",
"{\"Content-Type\":\"application/json\"}"
]
}

▪ Spécifiez les informations d'étendue dans le tableau "oauth2_params_scope", comme illustré dans l'exemple de tableau :

{
"oauth2_params_scope": [
"{\"READ\":\"READ_PRIVILEGES\"}"
]
}

▪ Spécifiez les informations needurl dans le tableau "oauth2_params_other", comme illustré dans l'exemple de tableau :

{
"oauth2_params_other": [
"{\"needurl\":\"true\"}"
]
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

ThingWorx

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un serveur ThingWorx :

1. Configurez ThingWorx en tant que fournisseur de ressources pour permettre à ThingWorx de répondre aux requêtes via le protocole OAuth2.

2. Pour ajouter un fournisseur OAuth pour ThingWorx, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth PingFederate.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth PingFederate.
BASE_URL	Spécifie l'URL de l'OAuth PingFederate.	https://<FQDN Pingfederate>:<Port>/as
RESOURCE_URL	Spécifie l'URL de ThingWorx. Il est recommandé de fournir la RESOURCE_URL lors de la configuration de l'OAuth. Si vous ne spécifiez pas la RESOURCE_URL, l'utilisateur devra la fournir lors de l'ajout d'un connecteur OAuth.	https://<FQDN Thingworx>:<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>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Trello

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un compte Trello :

1. Créez un compte développeur Trello et un compte Trello.

Dans les paramètres, définissez les valeurs appropriées du paramètre suivant :

▪ URL de redirection : spécifiez l'URL de renvoi ThingWorx Flow sous Allowed Origins au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

2. Pour ajouter un fournisseur OAuth pour Trello, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CONSUMER_KEY	Spécifie la clé consommateur à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans les clés API du développeur Trello.
CONSUMER_SECRET	Valeur de secret consommateur.	Récupérez la valeur dans les clés API du développeur Trello.

"trello": {
"Trello": {
"CONSUMER_SECRET": "<client secret here>",
"CONSUMER_KEY": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Windchill

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un serveur Windchill :

1. Configurez les paramètres OAuth sur le serveur Windchill.

2. Pour ajouter un fournisseur OAuth pour Windchill, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth PingFederate.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth PingFederate.
BASE_URL	Spécifie l'URL de l'OAuth PingFederate.	https://<FQDN Pingfederate>:<Port>/as
SCOPE	Limite l'accès de l'application à un compte d'utilisateur en émettant des jetons d'accès sur la base des étendues accordées. Pour ajouter plusieurs étendues, séparez-les par une virgule (,).	WINDCHILL_READ, <scope1>, <scope2>
PF_IDP_ADAPTER_ID	Facultatif. Spécifie l'ID d'adaptateur IdP PingFederate de votre configuration. A indiquer uniquement si vous disposez de plusieurs adaptateurs IdP dans PingFederate.	PingFederateAdapterID
RESOURCE_URL	Facultatif. Spécifie l'URL de Windchill. Il est recommandé de fournir la RESOURCE_URL lors de la configuration de l'OAuth. Si vous ne spécifiez pas la RESOURCE_URL, l'utilisateur devra la fournir lors de l'ajout d'un connecteur OAuth.	<protocole>://<FQDN Windchill>:<Port>/Windchill

"windchill": {
"Windchill": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"base_url": "<base url here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Windchill RV&S

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour un serveur Windchill RV&S :

1. Configurez les paramètres OAuth sur le serveur Windchill RV&S.

2. Pour ajouter un fournisseur OAuth pour Windchill RV&S, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre client OAuth PingFederate.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre client OAuth PingFederate.
BASE_URL	Spécifie l'URL de l'OAuth PingFederate.	https://<FQDN Pingfederate>:<Port>/as

"integrity": {
"integrity": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>",
"base_url": "<base url here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Zendesk

Procédez comme suit chaque fois que vous souhaitez ajouter un fournisseur OAuth pour une application Zendesk :

1. Créez votre application Zendesk.

Lors de la création de l'application, définissez les valeurs appropriées des paramètres suivants :

▪ Scopes : définissez les étendues appropriées pour l'application.

▪ Redirect URL : spécifiez l'URL de renvoi ThingWorx Flow au format https://<NomHôte:Port>/Thingworx/Oauths/oauth/return.

La vidéo suivante montre les étapes à suivre pour activer la configuration OAuth pour Zendesk :

2. Pour ajouter un fournisseur OAuth pour Zendesk, spécifiez les valeurs suivantes dans le fichier JSON de configuration OAuth :

Paramètre	Description	Valeur
CLIENT_ID	Spécifie l'identificateur client à utiliser pour les jetons d'accès de validation du serveur d'autorisation.	Récupérez la valeur dans votre application Zendesk.
CLIENT_SECRET	Valeur de la clé secrète client.	Récupérez la valeur dans votre application Zendesk.

"zendesk": {
"Zendesk": {
"CLIENT_SECRET": "<client secret here>",
"CLIENT_ID": "<client id here>"
}
}

3. Exécutez le service LoadOAuthConfiguration depuis ThingWorx Composer pour charger le fournisseur OAuth sur le serveur ThingWorx Flow.

Dépannage

Scénario

Solution

Vous ne pouvez pas ajouter un fournisseur OAuth si un connecteur OAuth utilise un fournisseur OAuth existant portant le même nom.

Tous les autres fournisseurs OAuth valides présents dans le même fichier JSON ne sont pas chargés.

• Ajoutez un nom de fournisseur OAuth unique, puis chargez votre configuration OAuth.

Par exemple, si Gmail-1 existe déjà dans la configuration OAuth, ajoutez Gmail-2 au fichier JSON de configuration OAuth, comme illustré dans l'exemple de code suivant :

• Supprimez tous les connecteurs qui utilisent le fournisseur OAuth existant, chargez à nouveau le fournisseur OAuth, puis redémarrez le service OAuth.

Pour redémarrer le service OAuth, procédez comme suit :

a. Sur le système sur lequel ThingWorx Flow est installé, ouvrez une invite de commande en tant qu'administrateur.

b. Exécutez la commande pm2 ls pour obtenir le numéro du service OAuth.

c. Exécutez la commande pm2 restart <numéro_service_OAuth> pour redémarrer le serveur OAuth.

Sur le système sur lequel ThingWorx Flow est installé, ouvrez une invite de commande en tant qu'administrateur, puis exécutez la commande pm2 restart flow-oauth-server pour redémarrer le serveur OAuth.

Est-ce que cela a été utile ?