Upgrading and Migrating SAP SuccessFactors Connector to Version 4.0 - Mule 4

Upgrade Anypoint Connector for SAP SuccessFactors (SuccessFactors Connector) to version 4.0.0 to use OAuth 2.0 SAML Bearer Assertion for authentication.

Supported Upgrade Paths

From Version To Version



Changes in This Release

SuccessFactors Connector 4.0 includes the following changes:

  • SuccessFactors Connector 4.0 now supports OAuth 2.0 SAML Bearer Assertion authentication.
    The implementation of OAuth 2.0 with Bearer SAML Assertion authentication is based on the internal mule-oauth-client library, which requires you to use Mule 4.2.x or higher with this version of the connector.

  • Refactored error types and exception handling.

  • Renamed the connector package to comply with Mule best practices.


To take advantage of the security offered by using OAuth 2.0 SAML Bearer Assertion for authentication, you must configure your SuccessFactors account and instance with an application that can connect using OAuth.

Use the SAP SuccessFactors OData API to Generate Access Tokens

SAP SuccessFactors OData API supports two-legged authentication for OAuth 2.0. You can use the OData APIs to generate access tokens for OAuth 2.0 authentication:

  1. Use /oauth/idp to pass a private key to generate a signed SAML assertion.

  2. Use /oauth/token to pass a token for signing in a SAML assertion.

  3. Use /odata/v2 to use the access token for authentication and access the OData APIs.

  4. Use /oauth/validate to pass the access token to the API and verify that it’s still valid.
    A token is only valid for 24 hours after it’s generated.

Upgrade Prerequisites

Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you need to restore to them.

Upgrade Steps

Follow these steps to perform the upgrade:

  1. In Anypoint Studio, create a Mule project.

  2. In the Mule Palette view, click Search in Exchange.

  3. In Add Dependencies to Project, enter successfactors in the search field.

  4. In Available modules, select SuccessFactors and click Add.

  5. Click Finish.

  6. Verify that the SAP SuccessFactors Connector dependency version is 4.0.0 in the pom.xml file in the Mule project.

Studio upgrades the connector automatically.

Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

  1. In Studio, verify that there are no errors in the Problems or Console views.

  2. Verify that there are no problems in the project pom.xml file.

  3. Test the connection to verify that the operations work.


If there are problems with caching the parameters and caching the metadata, try restarting Anypoint Studio.

Revert the Upgrade

If it is necessary to revert to the previous version of SAP SuccessFactors Connector, change the sap-successfactors-connector dependency version 4.0.0 in the project’s pom.xml to the previous version.

You must update the project’s pom.xml in Anypoint Studio.

Was this article helpful?

πŸ’™ Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!