CData Python Connector for SAP SuccessFactors

Build 20.0.7745

Establishing a Connection

The objects available within our connector are accessible from the "cdata.sapsuccessfactors" module. In order to use the module's objects directly, the module must first be imported as below:

import cdata.sapsuccessfactors as mod

From there, the connect() method can be called from the connector object to establish a connection using an appropriate connection string, such as the below:

mod.connect("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com")

The CData Python Connector for SAP SuccessFactors communicates to SAP SuccessFactors over the OData API. By default, it is enabled. However, if you need to provide additional permissions, please follow the steps from SAP laid out in their support here.

Connecting to SAPSuccessFactors

You can authenticate to SAP SuccessFactors using Basic authentication or OAuth with SAML assertion.

Basic Authentication

You must provide values for the following properties to successfully authenticate to SAP SuccessFactors. Note that the provider will reuse the session opened by SAP SuccessFactors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP SuccessFactors will be used for authentication.

  • Url, set this to the url of the server hosting Success Factors. Some of the servers are listed here.
  • User, set this to the username of your account.
  • Password, set this to the password of your account.
  • CompanyId, set this to the unique identifier of your company.

OAuth Authentication

You must provide values for the following properties, which will be used to get the access token.

  • OAuthGrantType, set this to CLIENT if you are working with an LMS (Learning Micro Services) in order to authenticate to the service. For all the other OData services use SAML. Default value for this property is SAML. Note that this property is only available for OAuth authentication.
  • Url, set this to the url of the server hosting Success Factors. Some of the servers are listed here. In case of connecting to a LMS (Learning Micro Service) the full URL should be specified including the service name.
  • User, set this to the username of your account.
  • CompanyId, set this to the unique identifier of your company.
  • OAuthClientId, set this to the API Key that was generated in API Center.
  • OAuthClientSecret, the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
  • InitiateOAuth, set this to GETANDREFRESH.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 20.0.7745