Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

packages/salesforce: Update docs to reflect the use of optional security token #11512

Merged
merged 6 commits into from
Nov 4, 2024
Merged

packages/salesforce: Update docs to reflect the use of optional security token #11512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
492cbd5
Update docs
bacherol Oct 24, 2024
e515012
elastic-package build
shmsr Oct 25, 2024
0b94466
Update field description as well
shmsr Oct 25, 2024
7cf3831
Do the change in _dev/build/docs
shmsr Oct 25, 2024
4915265
use backticks instead of quotes
shmsr Oct 25, 2024
e96f879
Improve docs
shmsr Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion packages/salesforce/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions packages/salesforce/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 3 additions & 1 deletion packages/salesforce/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion packages/salesforce/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down