[GitHub] [airflow] mik-laj commented on a change in pull request #10482: Add howto doc for salesforce connection

[GitBox <gi...@apache.org>]

mik-laj commented on a change in pull request #10482:
URL: https://github.com/apache/airflow/pull/10482#discussion_r475149270



##########
File path: docs/howto/connection/salesforce.rst
##########
@@ -0,0 +1,62 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+.. _howto/connection:SalesforceHook:
+
+Salesforce Connection
+==============================
+The HTTP connection type provides connection to Salesforce.
+
+Configuring the Connection
+==========================
+Host (required)
+    specify the host address to connect: ``https://your_host.lightning.force.com``
+
+Login (required)
+    Specify the email address used to login to your account.
+
+Password (required)
+    Specify the password associated with the account.
+
+Extra (required)
+    Specify the extra parameters (as json dictionary) that can be used in Salesforce
+    connection.
+    The following parameter is required:
+
+    * ``security_token``: Salesforce token.
+
+    The following parameter is optional:
+
+    * ``domain``: set to ``test`` if working in sandbox mode.
+
+    For security reason we suggest you to use one of the secrets Backend to create this
+    connection(Using ENVIRONMENT VARIABLE or Hashicorp Vault, GCP Secrets Manager etc).
+
+
+Examples for the **Extra** field
+--------------------------------
+Setting up sandbox mode:
+
+.. code-block:: json
+
+    {
+      "security_token": "your_token",
+      "domain":"test"
+    }
+
+.. note::
+  Airflow currently does not support other login methods such as IP filtering and JWT.

Review comment:
       Can you add example URI? This is helpful if you configure the connection using environment variables or secrets backend.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org