Skip to main content

Set up username-password flow

Important

Atlan currently supports Salesforce Sales Cloud and Financial Services Cloud (FSC).

Atlan supports the Salesforce OAuth 2.0 username-password flow for scenarios where server-to-server integration isn't possible. This flow enables Atlan to authenticate using the integration user's credentials along with a connected app in Salesforce.

Prerequisites​

Before you begin, make sure you have:

  • Salesforce administrator access
  • Network connectivity between Atlan and your Salesforce instance

Create connected app​

To enable Atlan to connect to your Salesforce instance, you need to create a connected app. This app provides the OAuth credentials that Atlan uses for authentication.

  1. Log in to Salesforce.
  2. In the upper right, click the settings icon and select Setup.
  3. In Setup, enter apps in the Quick Find box and select App Manager.
  4. Click New Connected App in the upper-right corner.
  5. Under Basic Information, provide:
    • Connected App Name: for example, AtlanConnector
    • Contact Email: your email address
  6. Under API (Enable OAuth Settings):
    • Check Enable OAuth Settings
    • Check Enable for Device Flow
    • Set Callback URL to any domain, for example, https://localhost (unused)
    • Add the following Selected OAuth Scopes:
      • Access Lightning applications (lightning)
      • Manage user data via APIs (api)
      • Perform requests at any time (refresh_token, offline_access)
    • Check Require Secret for Web Server Flow
    • Check Require Secret for Refresh Token Flow
  7. Click Save.
  8. On the resulting page, click Continue.
  9. Under API (Enable OAuth Settings), click Manage Consumer Details and copy:
    • Consumer Key (Client ID)
    • Consumer Secret (Client Secret)
  10. Wait approximately 10 minutes for the connected app to activate.

Retrieve security token​

Salesforce requires a security token in addition to your password for API access. You'll need to retrieve this token from your user settings and append it to your password when configuring the connection in Atlan.

  1. In Salesforce, click the integration user's user icon in the upper-right and select Settings.
  2. Expand My Personal Information and click Reset My Security Token.
  3. Click Reset Security Token.
  4. Copy the resulting security token.
Important

To crawl Salesforce, enter your password + security token in the Password field (for example, password xyz and token 123 → xyz123).

Troubleshooting​

If you encounter issues with Username-password authentication, see Troubleshooting Salesforce Connectivity.

Next steps​

  • Crawl Salesforce: Configure and run your first crawl to discover Salesforce data and metadata