> For the complete documentation index, see [llms.txt](https://docs.elimity.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/sap-successfactors.md). # SAP SuccessFactors The SAP SuccessFactors connector for Elimity Insights fetches users for an SAP SuccessFactors tenant so you can keep in control of your environment. Follow the instructions below to set up the connector for your environment. ## 1. Setting up a dedicated user in SAP SuccessFactors The SAP SuccessFactors connector for Elimity Insights authenticates as an OAuth client application bound to a user. We recommend creating a dedicated user to assign the minimal amount of permissions. Refer to [the official documentation](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/534356acc0ab4b0e8977ebfb2eb432f7/02e3e0b3966c42299653b495a42b292f.html) for instructions on how to create a new user in SAP SuccesFactors. Note down the newly created user's username. ## 2. Setting up a dedicated permission role in SAP SuccessFactors We also recommend creating a dedicated permission role for the newly created user. This permission role should only grant the 'Employee Export' permission. [The official documentation](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/b569eee64d3f4159b2b5272ba7d6b127/6d8998d9504843a58fe299ff6935a268.html) contains more information about creating a new permission role in SAP SuccessFactors. ## 3. Setting up a dedicated permission group in SAP SuccessFactors To assign the newly created permission role to the newly created user, we recommend using a dedicated static permission group. Refer to [the official documentation](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/b569eee64d3f4159b2b5272ba7d6b127/c15b3696a56e4601ae110c1c37c34a3d.html) for instructions in how to create a new static permission group in SAP SuccessFactors. ## 4. Assigning the permission role in SAP SuccessFactors Follow the instructions listed in [the official documentation](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/b569eee64d3f4159b2b5272ba7d6b127/fbaadf758e00485893d6f099e9f342fa.html) to assign the newly created permission role to the newly created permission group. ## 5. Setting up an OAuth client application in SAP SuccessFactors Create a new OAuth client application as described in [the official documentation](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/6b3c741483de47b290d075d798163bc1.html). We recommend enabling the 'Bind to Users' option and entering the newly created user's username in the 'User IDs' field. For the 'X.509 Certificate' field, we recommend to generate your own certificate and private key; for example by using the following OpenSSL command: ```shell-session $ openssl req -days 999 -keyout key.pem -newkey rsa -nodes -out cert.pem -subj '/CN=elimity-insights' -x509 ``` Remember to strip out the beginning and ending lines from the certificate contents before pasting into the 'X.509 Certificate' field. Securely store the private key you generated, you will need it to set up the new source in Elimity Insights. Also note down the newly created application's API key. ## 6. Creating a source in Elimity Insights In Elimity Insights you can now create a new SAP SuccessFactors source providing the following configuration options:
Configuration optionDescription
Gateway URLURL of the Elimity Insights SAP SuccessFactors gateway; SaaS customers can stick to the default of https://sap-sf.gateways.elimity.com. On-premise customers wishing to self-host can refer to our documentation about gateways and import agents for more information.
API keyAPI key you noted down in step 5.
API URLURL of the API server for your SAP SuccessFactors tenant; refer to the official documentation for more information.
Company IDYour SAP SuccessFactors company identifier, refer to the official documentation for instructions on how to find this information.
User IDUsername of the newly created user, which you noted down in step 1.
X.509 private keyPrivate key you stored in step 5.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.elimity.com/reference-manual/v3.44.2/built-in-connectors/sap-successfactors.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.