From c33df3f817d3cf6c42824fe458a4fd009968c1c0 Mon Sep 17 00:00:00 2001 From: Leandro de Lima Camargo Date: Mon, 4 Nov 2024 00:48:53 -0300 Subject: [PATCH] packages/salesforce: Update docs to reflect the use of optional security token (#11512) * Update docs --------- Co-authored-by: subham sarkar --- packages/salesforce/_dev/build/docs/README.md | 4 +++- packages/salesforce/changelog.yml | 3 +++ packages/salesforce/docs/README.md | 4 +++- packages/salesforce/manifest.yml | 3 ++- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/packages/salesforce/_dev/build/docs/README.md b/packages/salesforce/_dev/build/docs/README.md index 3ea06e704b4..59c67917d25 100644 --- a/packages/salesforce/_dev/build/docs/README.md +++ b/packages/salesforce/_dev/build/docs/README.md @@ -137,7 +137,9 @@ The User ID of the registered user. ### Password -The password used to authenticate the user. +The password used to authenticate the user with your Salesforce instance. + +When using a Salesforce instance with a security token, append the token directly to your password without spaces or special characters. For example, if your password is `password` and your security token is `12345`, enter: `password12345`. ### Token URL diff --git a/packages/salesforce/changelog.yml b/packages/salesforce/changelog.yml index 5b95808c89b..9d60b91fa04 100644 --- a/packages/salesforce/changelog.yml +++ b/packages/salesforce/changelog.yml @@ -7,6 +7,9 @@ - description: Improve the Salesforce integration documentation and field descriptions. type: enhancement link: https://github.com/elastic/integrations/pull/11452 + - description: Update docs to reflect the use of optional security token. + type: enhancement + link: https://github.com/elastic/integrations/pull/11512 - version: "0.15.1" changes: - description: Improve the Salesforce integration documentation. diff --git a/packages/salesforce/docs/README.md b/packages/salesforce/docs/README.md index 5158d9fbe54..4d4c8ce1023 100644 --- a/packages/salesforce/docs/README.md +++ b/packages/salesforce/docs/README.md @@ -137,7 +137,9 @@ The User ID of the registered user. ### Password -The password used to authenticate the user. +The password used to authenticate the user with your Salesforce instance. + +When using a Salesforce instance with a security token, append the token directly to your password without spaces or special characters. For example, if your password is `password` and your security token is `12345`, enter: `password12345`. ### Token URL diff --git a/packages/salesforce/manifest.yml b/packages/salesforce/manifest.yml index 49c1fba0f1a..7eab78364f5 100644 --- a/packages/salesforce/manifest.yml +++ b/packages/salesforce/manifest.yml @@ -67,7 +67,8 @@ vars: type: password title: Password secret: true - description: The password associated with your Salesforce account, used for OAuth 2.0 Username-Password authentication flow. + description: | + The password for your Salesforce account, used in the OAuth 2.0 Username-Password authentication flow. If a security token is required, append it to the password. For example, if your password is `password` and your security token is `12345`, enter `password12345`. required: false show_user: true default: password