Configuración y carga de elementos OAuth

ThingWorx Flow > Instalación y configuración > Configuración de ThingWorx Flow > Configuración y carga de elementos OAuth

Antes de crear un conector de OAuth para cualquier servicio o utilidad de terceros, se debe cargar su proveedor de OAuth en el servidor de ThingWorx Flow. La plantilla del fichero JSON de configuración de OAuth de ejemplo está disponible en el parámetro oauthConfigurations del servicio LoadOAuthConfiguration del elemento WorkflowSubsystem en ThingWorx Composer. A continuación se muestra un resumen de nivel superior del proceso de carga de elementos OAuth:

1. Cree una aplicación en el sistema de terceros.

2. Recupere el par de ID de cliente-secreto de cliente de la aplicación y añádalo al fichero JSON de la configuración OAuth de ejemplo. Añada los valores de los parámetros adicionales necesarios para la configuración de OAuth.

Para quitar la configuración de OAuth de cualquier servicio o utilidad de terceros, se debe quitar todo el objeto JSON. Por ejemplo, para quitar la configuración de OAuth para Gmail, se debe quitar el siguiente objeto JSON:

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

Si se ha quitado un objeto JSON para cualquier servicio o utilidad de terceros y desea añadir su configuración de OAuth más tarde, es necesario añadir el fragmento de código de JSON de la plantilla de fichero JSON de configuración de OAuth de ejemplo y proporcionar los valores necesarios para la configuración de OAuth.

En el fichero de configuración de ejemplo se incluyen los valores de configuración del conector que representan el servicio o la utilidad de terceros. Por ejemplo, para Gmail, no se debe modificar google_gmail en el objeto JSON. Para añadir varios proveedores de OAuth para Gmail, por ejemplo, Gmail-1 y Gmail-2, añada el siguiente objeto JSON al fichero de ejemplo:

{
"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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

ThingWorx Flow soporta OAuth para los siguientes servicios y utilidades:

• Azure

• Bitly

• Box

• Dialogflow

• Dropbox

• Dynamics 365 CRM

• Excel Online

• Github

• Gitlab

• Gmail

• Google Drive

• Formularios de Google

• Hojas de cálculo de Google

• Tareas de Google

• Traductor de Google

• HTTP

• JIRA

• OData

• OSLC

• Office 365

• OneDrive

• SAP OData

• SOAP

• Salesforce

• ServiceMax

• Slack

• Swagger

• ThingWorx

• Trello

• Windchill

• Windchill RV&S

• YouTube

• Zendesk

Configuración y carga de elementos OAuth para servicios y utilidades

Azure

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Azure:

1. Cree una aplicación de Azure.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ API Permissions: gestión de servicios de Azure.

▪ Redirect URI: introduzca el URL de retorno de ThingWorx Flow en el formato https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Azure, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Azure.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Azure.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Bitly

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Bitly:

1. Cree una aplicación de Bitly.

Al crear la aplicación, defina el URI de redireccionamiento en un URL de retorno de ThingWorx Flow con el formato https://<Nombre de host:Puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Bitly, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Bitly.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Bitly.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Box

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Box:

1. Cree una aplicación de Box.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Application Scopes: permite seleccionar todos los ámbitos.

▪ Redirect URI: introduzca el URL de retorno de ThingWorx Flow en el formato https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

En el siguiente vídeo se muestran los pasos necesarios para activar la configuración de OAuth para Box:

2. Para añadir un proveedor de OAuth para Box, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Box.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Box.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Dialogflow

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Dialogflow:

1. Configuración de OAuth para el proyecto Dialogflow.

Durante la creación de la aplicación, proporcione el URI de redireccionamiento como un URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

Para añadir un proveedor de OAuth para la aplicación de Dialogflow, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Google.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Google.

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

2. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Dropbox

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Dropbox:

1. Cree una aplicación de Dropbox. En este vínculo se proporciona información sobre Dropbox OAuth.

Al crear la aplicación, defina los valores adecuados para los siguientes parámetros:

▪ API: seleccione la API de Dropbox.

▪ Type of access: Dropbox completo.

▪ Redirect URI: introduzca el URL de retorno de ThingWorx Flow en el formato https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Dropbox, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Dropbox.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Dropbox.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Dynamics 365 CRM

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Dynamics 365 CRM:

1. Cree una aplicación de Azure Active Directory.

Al crear la aplicación, defina el URI de redireccionamiento en un URL de retorno de ThingWorx Flow con el formato https://<Nombre de host:Puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Dynamics 365 CRM, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Azure.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Azure.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Excel Online, Office 365, OneDrive

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Excel Online, Office 365 u OneDrive:

1. Cree una aplicación de Azure.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ API Permissions: gestión de servicios de Azure.

▪ Redirect URI: introduzca el URL de retorno de ThingWorx Flow en el formato https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Excel Online, Office 365 o OneDrive, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Azure.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de 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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Github

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de GitHub:

1. Cree una aplicación de Github OAuth.

Al crear la aplicación, defina el URL de devolución de llamada de autorización en un URL de retorno de ThingWorx Flow en el formato https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Github, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Github.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Github.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Gitlab

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Gitlab:

1. Cree una aplicación de GitLab.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Scopes: api, read_user, read_repository, read_registry.

▪ Redirect URI: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Gitlab, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de GitLab.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de GitLab.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Gmail, Google Drive, Formularios de Google, Hojas de cálculo de Google, Tareas de Google, Traductor de Google, YouTube

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Google:

1. Configuración de OAuth para la aplicación de Google.

Durante la creación de la aplicación, proporcione el URI de redireccionamiento como un URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

Para añadir un proveedor de OAuth para la aplicación de Google, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Google.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de 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>" } }
Formularios de Google "google_form": { "Google Form": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }	Hojas de cálculo de Google "google_sheet": { "Google Sheet": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }
Tareas de Google "google_task": { "Google Tasks": { "CLIENT_SECRET": "<client secret here>", "CLIENT_ID": "<client id here>" } }	Traductor de Google "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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

HTTP

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para un servidor HTTP:

1. Configure OAuth en el servidor HTTP.

2. Para añadir un proveedor de OAuth para el servidor HTTP, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
AUTH_URL [Obligatorio]	Permite especificar el extremo de OAuth para las solicitudes de token.	Recupere el valor del cliente de OAuth. Ejemplo: \authorize
TOKEN_URL [Obligatorio]	Permite proporcionar el token de acceso.	Recupere el valor del cliente de OAuth. Ejemplo: \token
VALIDATE_URL [Obligatorio]	Permite especificar el URL que se utiliza para validar el token de acceso.	Recupere el valor del cliente de OAuth. • Si no desea VALIDATE_URL, indique el URL del servidor accesible. Ejemplo: https://www.dropbox.com/ • Si desea implementar VALIDATE_URL utilice el método get para crear la API.
REFRESH_URL	Permite especificar el URL que se utilizará para obtener los tokens de acceso.	Recupere el valor del cliente de OAuth. Ejemplo: \token
SCOPE [Obligatorio]	Permite proporcionar una lista de ámbitos separados por espacios para la aplicación.	<ÁMBITO 1> <ÁMBITO 2>
BASE_URL [Obligatorio]	Permite especificar el URL del servidor de autorización central.	Recupere el valor del cliente de OAuth.
NEED_RESOURCE_URL [Obligatorio]	Permite especificar si el usuario debe proporcionar RESOURCE_URL al añadir el conector de OAuth. Si se define en Verdadero, se debe especificar el valor de RESOURCE_URL al añadir el proveedor de OAuth. Si se define en Falso, el usuario debe especificar el valor de RESOURCE_URL al añadir el conector de OAuth.	verdadero o falso
RESOURCE_URL	Permite especificar el URL del servidor de recursos.	—
CLIENT_ID [Obligatorio]	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de OAuth.
CLIENT_SECRET [Obligatorio]	Valor del secreto de cliente.	Recupere el valor del cliente de 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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

JIRA

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de JIRA:

1. Cree una aplicación de JIRA.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

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

▪ Callback URL: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para JIRA, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de JIRA.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de JIRA.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

OData

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para la instancia de OData:

1. Configure OAuth en la instancia de OData.

2. Según la configuración de OAuth, proporcione valores en el fichero JSON de configuración de OAuth. Consulte el fichero config.json de ejemplo. A continuación se muestran valores de ejemplo que se pueden proporcionar para cargar elementos OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de OAuth.
VALIDATE_URL	Permite especificar el URL que se utiliza para validar el token de acceso.	Recupere el valor del cliente de OAuth.
REFRESH_URL	Permite especificar el URL que se utilizará para obtener los tokens de acceso.	Recupere el valor del cliente de OAuth.
TOKEN_URL	Permite proporcionar el token de acceso.	Recupere el valor del cliente de OAuth.
AUTH_URL	Permite especificar el extremo de OAuth para las solicitudes de token.	Recupere el valor del cliente de 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
}

▪ Proporcione información de cabecera en la matriz de "oauth2_validate_headers", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione información de ámbito en la matriz de "oauth2_params_scope", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione la información de needurl en la matriz de "oauth2_params_other", tal como se muestra en la matriz de ejemplo:

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

OSLC

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para el servidor OSLC:

1. Configure OAuth en el servidor OSLC.

2. Para añadir un proveedor de OAuth para OSLC, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor del cliente de OAuth.
BASE_URL	Permite especificar el URL de OAuth.	Recupere el valor del servidor de autorización central. Si el cliente de OAUth es PingFederate, este URL debe tener el siguiente formato: https://<FQDN de Pingfederate>:<Puerto>/as
VALIDATE_URL	Permite especificar el URL que se utiliza para validar el token de acceso.	Recupere el valor del servidor de autorización central. Ejemplo:/introspect.oauth2
RESOURCE_URL	Permite especificar el URL del servidor OSLC. Si no se especifica RESOURCE_URL, se deben proporcionar los valores para OAUTH_URL, REFRESH_URL y TOKEN_URL.	Recupere el valor del servidor de autorización central.
OAUTH_URL	Permite especificar el extremo de OAuth para las solicitudes de token.	Recupere el valor del servidor de autorización central. Ejemplo:/authorization.oauth2
REFRESH_URL	Permite especificar el URL que se utilizará para obtener los tokens de acceso.	Recupere el valor del servidor de autorización central. Ejemplo:/token.oauth2
TOKEN_URL	Permite proporcionar el token de acceso.	Recupere el valor del servidor de autorización central. Ejemplo:/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>"
}
}

Se debe especificar RESOURCE_URL o los parámetros de autorización (OAUTH_URL, REFRESH_URL y TOKEN_URL).

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

SAP OData

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para un servidor de SAP OData:

1. Configure OAuth en el servidor de SAP.

Durante la configuración de OAuth, proporcione el URI de redireccionamiento como un URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para SAP OData, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de SAP OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor del cliente de SAP OAuth.
BASE_URL	Permite especificar el URL del servidor de autorización central.	https://<nombre de host:puerto>/sap/bc/sec/oauth2
SCOPE	Lista de ámbitos separados por espacios. Para obtener más información, consulte OAuth Scopes.	<ÁMBITO 1> <ÁMBITO 2>
RESOURCE_URL	Permite especificar el URL de recurso de SAP. Se recomienda proporcionar RESOURCE_URL durante la configuración de OAuth. Si no se especifica el valor de RESOURCE_URL, el usuario debe proporcionarlo al añadir un conector de OAuth.	https://<host:puerto>/

"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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

SOAP

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para la instancia de SOAP:

1. Configure OAuth en la instancia de SOAP.

2. Según la configuración de OAuth, proporcione valores en el fichero JSON de configuración de OAuth. Consulte el fichero config.json de ejemplo. A continuación, se muestran valores de ejemplo que se pueden proporcionar para cargar elementos OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de OAuth.
VALIDATE_URL	Permite especificar el URL que se utiliza para validar el token de acceso.	Recupere el valor del cliente de OAuth.
REFRESH_URL	Permite especificar el URL que se utilizará para obtener los tokens de acceso.	Recupere el valor del cliente de OAuth.
TOKEN_URL	Permite proporcionar el token de acceso.	Recupere el valor del cliente de OAuth.
AUTH_URL	Permite especificar el extremo de OAuth para las solicitudes de token.	Recupere el valor del cliente de OAuth.

▪ Proporcione información de cabecera en la matriz de "oauth2_validate_headers", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione información de ámbito en la matriz de "oauth2_params_scope", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione la información de needurl en la matriz de "oauth2_params_other", tal como se muestra en la matriz de ejemplo:

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Salesforce

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Salesforce:

1. Cree una aplicación de Salesforce.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Scopes: permite proporcionar ámbitos adecuados a la aplicación.

▪ Callback URL: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Salesforce, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Salesforce.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Salesforce.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

En el siguiente vídeo se muestran los pasos necesarios para activar la configuración de OAuth para Salesforce:

ServiceMax

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de ServiceMax:

1. Después de conectarse a ServiceMax, cree una aplicación de Servicemax.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Scopes: permite proporcionar ámbitos adecuados a la aplicación.

▪ Callback URL: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Servicemax, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Servicemax.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Servicemax.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Slack

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Slack:

1. Cree la aplicación de Slack.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Scopes: permite proporcionar ámbitos adecuados a la aplicación.

▪ Redirect URL: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Slack, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Slack.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Slack.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Swagger

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para la instancia de Swagger:

1. Configure OAuth en la instancia de Swagger.

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de OAuth.
VALIDATE_URL	Permite especificar el URL que se utiliza para validar el token de acceso.	Recupere el valor del cliente de OAuth.
REFRESH_URL	Permite especificar el URL que se utilizará para obtener los tokens de acceso.	Recupere el valor del cliente de OAuth.
TOKEN_URL	Permite proporcionar el token de acceso.	Recupere el valor del cliente de OAuth.
AUTH_URL	Permite especificar el extremo de OAuth para las solicitudes de token.	Recupere el valor del cliente de OAuth.

▪ Proporcione información de cabecera en la matriz de "oauth2_validate_headers", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione información de ámbito en la matriz de "oauth2_params_scope", tal como se muestra en la matriz de ejemplo:

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

▪ Proporcione la información de needurl en la matriz de "oauth2_params_other", tal como se muestra en la matriz de ejemplo:

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

ThingWorx

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para un servidor de ThingWorx:

1. Configure ThingWorx como proveedor de recursos para que ThingWorx pueda responder a solicitudes a través del protocolo OAuth2.

2. Para añadir un proveedor de OAuth para ThingWorx, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de PingFederate OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor del cliente de PingFederate OAuth.
BASE_URL	Permite especificar el URL de PingFederate OAuth.	https://<FQDN de Pingfederate>:<Puerto>/as
RESOURCE_URL	Permite especificar el URL de ThingWorx. Se recomienda proporcionar RESOURCE_URL durante la configuración de OAuth. Si no se especifica el valor de RESOURCE_URL, el usuario debe proporcionarlo al añadir un conector de OAuth.	https://<FQDN de Thingworx>:<Puerto>/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. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Trello

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una cuenta de Trello:

1. Cree una cuenta de desarrollador de Trello y una cuenta de Trello.

En la configuración, defina los valores adecuados del siguiente parámetro:

▪ URL de redirección: introduzca el URL de retorno de ThingWorx Flow en Allowed Origins, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

2. Para añadir un proveedor de OAuth para Trello, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CONSUMER_KEY	Permite especificar la clave de consumidor que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de las claves de API de desarrollador de Trello.
CONSUMER_SECRET	Valor del secreto de consumidor.	Recupere el valor de las claves de API de desarrollador de Trello.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Windchill

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para un servidor de Windchill:

1. Configure OAuth en el servidor de Windchill.

2. Para añadir un proveedor de OAuth para Windchill, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de PingFederate OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor del cliente de PingFederate OAuth.
BASE_URL	Permite especificar el URL de PingFederate OAuth.	https://<FQDN de Pingfederate>:<Puerto>/as
SCOPE	Permite limitar el acceso de la aplicación a una cuenta de usuario mediante la emisión de tokens de acceso en función de los ámbitos concedidos. Para añadir varios ámbitos, se deben separar mediante una coma (,).	WINDCHILL_READ, <scope1>, <scope2>
PF_IDP_ADAPTER_ID	Opcional. Permite especificar el ID de adaptador IdP de PingFederate de la configuración. Solo se debe especificar si hay varios adaptadores IdP en PingFederate.	PingFederateAdapterID
RESOURCE_URL	Opcional. Permite especificar el URL de Windchill. Se recomienda proporcionar RESOURCE_URL durante la configuración de OAuth. Si no se especifica el valor de RESOURCE_URL, el usuario debe proporcionarlo al añadir un conector de OAuth.	<protocolo>://<FQDN de Windchill>:<Puerto>/Windchill

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Windchill RV&S

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para un servidor de Windchill RV&S:

1. Configure OAuth en el servidor de Windchill RV&S.

2. Para añadir un proveedor de OAuth para Windchill RV&S, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor del cliente de PingFederate OAuth.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor del cliente de PingFederate OAuth.
BASE_URL	Permite especificar el URL de PingFederate OAuth.	https://<FQDN de Pingfederate>:<Puerto>/as

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Zendesk

Realice los siguientes pasos cada vez que desee añadir un proveedor de OAuth para una aplicación de Zendesk:

1. Cree la aplicación de Zendesk.

Al crear la aplicación, defina los valores adecuados de los siguientes parámetros:

▪ Scopes: permite proporcionar ámbitos adecuados a la aplicación.

▪ Redirect URL: introduzca el URL de retorno de ThingWorx Flow, como https://<nombre de host:puerto>/Thingworx/Oauths/oauth/return.

En el siguiente vídeo se muestran los pasos necesarios para activar la configuración de OAuth para Zendesk:

2. Para añadir un proveedor de OAuth para Zendesk, proporcione los siguientes valores en el fichero JSON de configuración de OAuth:

Parámetro	Descripción	Value
CLIENT_ID	Permite especificar el identificador de cliente que se debe utilizar para tokens de acceso de validación del servidor de autorización.	Recupere el valor de la aplicación de Zendesk.
CLIENT_SECRET	Valor del secreto de cliente.	Recupere el valor de la aplicación de Zendesk.

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

3. Ejecute el servicio LoadOAuthConfiguration de ThingWorx Composer para cargar el proveedor de OAuth en el servidor de ThingWorx Flow.

Resolución de problemas

Escenario

Solución

No se puede añadir un proveedor de OAuth si un conector de OAuth está utilizando un proveedor de OAuth existente con el mismo nombre.

Los demás proveedores de OAuth válidos presentes en el mismo fichero JSON no se cargan.

• Añada un nombre de proveedor de OAuth único y, a continuación, cargue la configuración de OAuth.

Por ejemplo, si existe Gmail-1 en la configuración de OAuth, añada Gmail-2 al fichero JSON de la configuración de OAuth, tal como se muestra en el siguiente código de ejemplo:

O bien

• Borre los conectores que utilicen el proveedor de OAuth existente, vuelva a cargar el proveedor de OAuth y, a continuación, reinicie el servicio de OAuth.

Complete los siguientes pasos para reiniciar el servicio de OAuth:

a. En el sistema donde ThingWorx Flow está instalado, inicie el símbolo del sistema como administrador.

b. Ejecute el comando pm2 ls para obtener el número de servicio OAuth.

c. Ejecute el comando pm2 restart <número_servicio_OAuth> para reiniciar el servidor OAuth.

O bien

En el sistema en el que ThingWorx Flow está instalado, inicie el símbolo del sistema como administrador y ejecute el comando pm2 restart flow-oauth-server para reiniciar el servidor OAuth.

¿Fue esto útil?