Integrate with Salesforce

What is Salesforce

Salesforce is a cloud-based CRM platform that provides sales, service, marketing, and analytics applications.

-- https://salesforce.com

Preparation

The following placeholders are used in this guide:

• company.my.salesforce.com is the FQDN of your Salesforce organization.
• authentik.company is the FQDN of the authentik installation.

:::info This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. :::

authentik configuration

To support the integration of Salesforce with authentik, you must create property mappings for Just-in-Time (JIT) user provisioning and an application/provider pair.

Create property mappings

Salesforce JIT provisioning requires specific SAML attributes to automatically create users on first login.

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Customization > Property Mappings and click Create. Create five SAML Provider Property Mappings with the following settings:

   • Username Mapping:

     • Name: Choose a descriptive name
     • SAML Attribute Name: User.Username
     • Expression:
       pythonCopy

       return request.user.email
       

   • Email Mapping:

     • Name: Choose a descriptive name
     • SAML Attribute Name: User.Email
     • Expression:
       pythonCopy

       return request.user.email
       

   • Last Name Mapping:

     • Name: Choose a descriptive name
     • SAML Attribute Name: User.LastName
     • Expression:
       pythonCopy

       return request.user.name.split()[-1] if request.user.name else "User"
       

   • Profile ID Mapping:

     • Name: Choose a descriptive name

     • SAML Attribute Name: User.ProfileId

     • Expression:

       pythonCopy

       return "00eXXXXXXXXXXXXX" # Replace with your Salesforce Profile ID
       

       :::info Find your Salesforce Profile ID To find your Salesforce Profile ID, in Salesforce, navigate to Setup > Users > Profiles, click on the desired profile, and copy the 18-character ID from the URL (starts with 00e). :::

   • Federation Identifier Mapping:

     • Name: Choose a descriptive name
     • SAML Attribute Name: User.FederationIdentifier
     • Expression:
       pythonCopy

       return request.user.email
       

Create an application and provider in authentik

1. Log in to authentik as an administrator and open the authentik Admin interface.

2. Navigate to Applications > Applications and click Create with Provider to create an application and provider pair.

   • Application: provide a descriptive name, an optional group for the type of application, the policy engine mode, and optional UI settings. Take note of the Slug as it will be required later.
   • Choose a Provider type: select SAML Provider as the provider type.
   • Configure the Provider: provide a name (or accept the auto-provided name), the authorization flow to use for this provider, and the following required configurations.
     • Set the ACS URL to https://company.my.salesforce.com?so=XXXXXXXXX, replacing XXXXXXXXX with your Salesforce Organization ID.
     • Set the Issuer to a unique identifier (e.g., https://authentik.company).
     • Set the Service Provider Binding to Post.
     • Under Advanced protocol settings:
       • Select an available Signing Certificate.
       • Set NameID Property Mapping to authentik default SAML Mapping: Email.
       • Add all five Property Mappings you created in the previous section.
   • Configure Bindings (optional): you can create a binding (policy, group, or user) to manage the listing and access to applications on a user's My applications page.

3. Click Submit to save the new application and provider.

Download the signing certificate

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Applications > Providers and click on the name of the SAML provider you created.
3. Under Related objects > Download signing certificate, click Download. This certificate file will be required for the Salesforce configuration.

Salesforce configuration

Enable SAML Single Sign-On

1. Log in to your Salesforce organization as an administrator.
2. Navigate to Setup > Identity > Single Sign-On Settings.
3. Click Edit and enable SAML Enabled.
4. Click Save.

Create a new SAML Single Sign-On configuration

1. On the Single Sign-On Settings page, under SAML Single Sign-On Settings, click New.
2. Enter the following values:
   • Name: authentik
   • Issuer: Enter the same issuer value you configured in authentik (e.g., https://authentik.company).
   • Identity Provider Certificate: Upload the signing certificate that you downloaded from authentik.
   • Request Signing Certificate: Select the default certificate or leave as-is.
   • Request Signature Method: RSA-SHA256
   • SAML Identity Type: Select Assertion contains the Federation ID from the User object.
   • SAML Identity Location: Select Identity is in the NameIdentifier element of the Subject statement.
   • Service Provider Initiated Request Binding: HTTP POST
   • Identity Provider Login URL: Enter the SSO URL (Post) from your authentik provider: https://authentik.company/application/saml/<slug>/sso/binding/post/
3. Click Save.

Enable Just-in-Time provisioning

1. On the SAML Single Sign-On configuration page that you just created, click Edit.
2. Under Just-in-Time User Provisioning, check User Provisioning Enabled.
3. Select Standard for the provisioning type.
4. Click Save.

Salesforce as an OAuth Source

You can configure Salesforce as an OAuth source to allow users to log in to authentik using their Salesforce credentials. Optionally, this can be used alongside SCIM provisioning to keep your Salesforce users in sync with your authentik users.

Salesforce configuration

Create a Connected App

1. Log in to your Salesforce organization as an administrator.
2. Navigate to Setup and search for App Manager.
3. Click New External Client App.
4. Fill in the basic information:
   • Connected App Name: authentik
   • API Name: authentik
   • Contact Email: Your email address
5. Under API (Enable OAuth Settings):
   • Check Enable OAuth Settings.
   • Set Callback URL to https://authentik.company/source/oauth/callback/<slug>/, replacing <slug> with the slug you will use when creating the OAuth Source in authentik (e.g., salesforce).
   • Under Selected OAuth Scopes, add:
     • Access unique user identifiers (openid)
     • Manage user data via APIs (api)
   • Check Enable Client Credentials Flow if you plan to use SCIM with OAuth authentication.
   • Check Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows.
6. Click Save.

Configure Client Credentials Flow (required for SCIM with OAuth)

If you plan to use SCIM provisioning with OAuth authentication:

1. Navigate to Setup > External Client App Manager.
2. Find your Connected App and open it.
3. Click Edit Policies.
4. Under Client Credentials Flow:
   • Set Run As to an admin user that has permissions to manage users.
5. Click Save.

Get the Consumer Key and Secret

1. Navigate to Setup > External Client App Manager.
2. Find your Connected App and open it.
3. Under Settings > OAuth Settings, click Consumer Key and Secret.
4. Copy the Consumer Key and Consumer Secret.

authentik configuration

Create an OAuth Source

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Directory > Federation and Social login and click Create.
3. Select OpenID OAuth Source and click Next.
4. Enter the following values:
   • Name: Salesforce
   • Slug: salesforce (this must match the callback URL configured in Salesforce)
   • Consumer Key: Paste the Consumer Key from Salesforce.
   • Consumer Secret: Paste the Consumer Secret from Salesforce.
   • Authorization URL: https://company.my.salesforce.com/services/oauth2/authorize
   • Access Token URL: https://company.my.salesforce.com/services/oauth2/token
   • Profile URL: https://company.my.salesforce.com/services/oauth2/userinfo
   • Additional Scopes: *openid api (the * prefix overrides default scopes)
   • PKCE: Select S256.
5. Click Finish to save the source.

SCIM Provisioning (optional)

You can configure SCIM provisioning to automatically sync users from authentik to Salesforce. This guide only covers OAuth2 SCIM integration, which requires an enterprise authentik account.

Create SCIM property mappings

Salesforce requires specific SCIM attributes that are not included in the default mappings.

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Customization > Property Mappings and click Create. Create two SCIM Provider Mappings with the following settings:

   • Profile ID Mapping:

     • Name: Salesforce SCIM: Profile ID

     • Expression:

       pythonCopy

       return {
           "entitlements": [
               {
                   "value": "00eXXXXXXXXXXXXX"  # Replace with your Salesforce Profile ID
               }
           ]
       }
       

       :::info Find your Salesforce Profile ID To find your Salesforce Profile ID, in Salesforce, navigate to Setup > Users > Profiles, click on the desired profile, and copy the 18-character ID from the URL (starts with 00e). :::

   • Username Mapping:

     • Name: Salesforce SCIM: Username
     • Expression:
       pythonCopy

       return {
           "userName": request.user.email
       }
       

Create a SCIM provider

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Applications > Providers and click Create.
3. Select SCIM Provider as the provider type and click Next.
4. Enter the following values:
   • URL: https://company.my.salesforce.com/services/scim/v2
   • Authentication Mode: Select OAuth
   • OAuth Source: Select the Salesforce OAuth Source you created earlier.
   • OAuth Parameters: {"grant_type": "client_credentials"}
   • Compatibility Mode: Select Salesforce.
   • Under User Property Mappings, add the two SCIM mappings you created (Salesforce SCIM: Profile ID and Salesforce SCIM: Username) alongside the default user mapping.
5. Click Finish to save the provider.

Add the SCIM provider to your application

1. Log in to authentik as an administrator and open the authentik Admin interface.
2. Navigate to Applications > Applications and create or select your Salesforce application.
3. Click Edit.
4. In the Backchannel Providers field, select the SCIM provider you created.
5. Click Update to save the application.

Resources

• Salesforce Help - Configure SSO with Salesforce as a SAML Service Provider
• Salesforce Help - Just-in-Time SAML Assertion Fields for Salesforce
• Salesforce Help - SCIM User Provisioning
• Salesforce Help - External Client Apps