Konfigurieren der SuccessFactors OData API -Authentifizierung im Jitterbit App Builder
SuccessFactors unterstützt den OAuth 2.0 SAML Bearer Assertion-Flow. Dieser Flow bietet eine benutzerbeschränkte Autorisierung und tauscht SAML Assertionen gegen Zugriffstoken aus, wie in der folgenden Spezifikation beschrieben:
https://tools.ietf.org/html/draft-ietf-oauth-saml2-bearer-23
Dieses Dokument behandelt die folgenden Aufgaben:
- App Builder als SuccessFactors OAuth2-Clientanwendung registrieren
- Registrieren Sie SuccessFactors als App Builder Sicherheitsanbieter.
- Registrieren Sie den Datenquellenserver des SAP OData-Dienst.
Anforderungen
Um fortzufahren, benötigen Sie Folgendes:
- Ein bestehendes SuccessFactors-Konto.
- Administratorzugriff auf das SuccessFactors-Konto.
- Administratorzugriff auf App Builder.
App Builder als SuccessFactors OAuth2-Clientanwendung registrieren
App Builder muss in SuccessFactors als OAuth2-Clientanwendung registriert werden. Um App Builder als OAuth2-Clientanwendung zu registrieren, benötigen Sie die folgenden Informationen:
| Beispiel | Hinweise | |
|---|---|---|
| Anwendungsname | App Builder | Der Anwendungsname ist beliebig. Wenn Sie mehrere Instanzen von App Builder als OAuth2-Clientanwendungen registrieren, geben Sie jeder einen eindeutigen Namen. |
| Anwendungs URL | https://example.com/App Builder/ | Dies ist das Web-Root des App Builder. Die URL muss den abschließenden Schrägstrich enthalten. |
| Allgemeiner Name | example.com | Dies ist der Host des Webstamms. |
So registrieren Sie App Builder als SuccessFactors OAuth2-Clientanwendung:
- Melden Sie sich als Administrator bei SuccessFactors an
- Navigieren Sie zum Admin Center
- Wählen Sie Unternehmenseinstellungen → OAuth 2-Clientanwendungen verwalten
- Klicken Sie auf die Schaltfläche Client-Anwendung registrieren
- Geben Sie den Anwendungsnamen und die Anwendungs URL an
- Klicken Sie auf die Schaltfläche X.509-Zertifikat generieren
- Geben Sie den Common Name (CN) an
- Klicken Sie auf die Schaltfläche Generieren
- Klicken Sie auf die Schaltfläche Herunterladen, um das Zertifikat zu speichern
- Klicken Sie auf die Schaltfläche Registrieren
Nach der Registrierung weist SuccessFactors einen API - Schlüssel zu. Dieser wird zusammen mit dem Zertifikat für die weiteren Schritte benötigt.
Zertifikat konvertieren
SuccessFactors generiert ein Zertifikat im PEM-Format; App Builder benötigt ein Base64-kodiertes Zertifikat im PKCS#12-Format. Eine ausführliche Erläuterung dieses Themas geht über den Rahmen dieses Dokuments hinaus. Beispielsweise kann das OpenSSL-Befehlszeilenprogramm verwendet werden, um ein Zertifikat von PEM in PKCS#12 zu konvertieren:
openssl pkcs12 -in certificate.pem -export -out certificate.pfx
Beachten Sie, dass Sie zur Eingabe eines Passworts aufgefordert werden. Notieren Sie sich das Passwort, da Sie es später benötigen.
So kodieren Sie das Zertifikat mit Base64:
openssl base64 -in certificate.pfx -out certificate.txt-AWeitere Informationen zu SuccessFactors OAuth2-Clientanwendungszertifikaten finden Sie im folgenden Dokument:
http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf
Notiz
Zum jetzigen Zeitpunkt generiert SuccessFactors kein OpenSSL-kompatibles Zertifikat. Um das Zertifikat kompatibel zu machen, öffnen Sie es in einem Texteditor und nehmen Sie die folgenden Änderungen vor:
Ersetzen Sie beide Vorkommen von „ENCRYPTED PRIVATE KEY“ durch „PRIVATE KEY“.
Fügen Sie Zeilenumbrüche so ein, dass keine Zeile länger als 76 Zeichen ist. Beachten Sie, dass es sich um Zeilenumbrüche im Unix-Stil (Zeilenvorschub) handeln muss, nicht um Zeilenumbrüche im Windows oder Internet-Stil (Zeilenvorschub/Wagenrücklauf-Paare).
SuccessFactors als App Builder Sicherheitsanbieter registrieren
Um SuccessFactors als App Builder Sicherheitsanbieter zu registrieren, benötigen Sie die folgenden Informationen:
| Beispiel | Hinweise | |
|---|---|---|
| API Schlüssel | Der API Schlüssel wird von SuccessFactors bei der Registrierung der OAuth2-Clientanwendung zugewiesen (siehe oben). | |
| Signaturzertifikat | Das Signaturzertifikat muss ein Base64-kodiertes PKCS#12-Zertifikat sein, das den privaten Schlüssel enthält. Das Zertifikat kann manuell oder während der Registrierung der SuccessFactors OAuth2-Clientanwendung (siehe oben) generiert werden. | |
| Passwort für Signaturzertifikat | Das Passwort für das Signaturzertifikat wird bei der Generierung des PKCS#12-formatierten Zertifikats zugewiesen. | |
| Firmen-ID | Die SuccessFactors-Firmenkennung. | |
| Instanz API URL | https://api8.successfactors.com/ | SuccessFactors API URL: „Ihre Endpoint URLs für den Zugriff auf die OData APIs hängen vom Rechenzentrum ab, in dem Ihre SuccessFactors-Instanz gehostet wird.“ Siehe http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf für weitere Informationen. |
Notiz
Die URL enthält nicht den Pfad /odata/v2. App Builder hängt den Pfad an.
So registrieren Sie SuccessFactors als App Builder Sicherheitsanbieter:
- Melden Sie sich als Administrator beim App Builder an
- Navigieren Sie zur IDE
- Klicken Sie auf die Schaltfläche Sicherheitsanbieter
- Klicken Sie im Bereich „Datenquellenauthentifizierung“ auf die Schaltfläche + Datenquellenauthentifizierung
-
Geben Sie Folgendes an:
- Name: Ein eindeutiger Name des Sicherheitsanbieters.
- Beispiel: SuccessFactors
- Typ: SuccessFactors OData
-
Priorität: Eine eindeutige Ganzzahl zwischen 10 und 100. Beachten Sie, dass dieser Wert eindeutig sein muss.
Beispiel: 40
-
Klicken Sie auf die Schaltfläche Speichern
-
Legen Sie die folgenden Eigenschaften fest (Klicken Sie im Eigenschaftenfenster auf die Schaltfläche + Eigenschaft → Wählen Sie den Parameter aus → Geben Sie den Wert ein → Klicken Sie auf das Symbol Speichern):
- Authentifizierungstyp: Saml
- CompanyID: Firmen-ID
- ApiKey: * API Schlüssel*
- InstanceApiUrl: * URL der Instanz API *
- SigningCertificate: Signaturzertifikat
- SigningCertificatePassword: Passwort für Signaturzertifikat
-
Klicken Sie im Bereich „Anbieter“ auf die Schaltfläche Bearbeiten
- Aktivieren Sie die Option Aktiviert
- Klicken Sie auf die Schaltfläche Speichern
Registrieren des Datenquellenservers des SAP OData Dienstes
Um SuccessFactors als App Builder Datenquellenserver zu registrieren, benötigen Sie die folgenden Informationen:
| Beispiel | Hinweise | |
|---|---|---|
| OData Endpoint | https://api8.successfactors.com/odata/v2/ | SuccessFactors API URL: „Ihre Endpoint URLs für den Zugriff auf die OData APIs hängen vom Rechenzentrum ab, in dem Ihre SuccessFactors-Instanz gehostet wird.“ Siehe http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf für weitere Informationen. |
| Name des Sicherheitsanbieters | SuccessFactors | Der oben angegebene Name des Sicherheitsanbieters. |
Notiz
Seit März 2016 scheint der OData Endpoint einen abschließenden Schrägstrich zu erfordern.
So registrieren Sie SuccessFactors als App Builder Datenquellenserver:
- Melden Sie sich als Administrator beim App Builder an
- Navigieren Sie zur IDE
- Wählen Sie die Schaltfläche Datenserver
- Klicken Sie im Bereich Datenserver auf die Schaltfläche + Server
-
Geben Sie Folgendes an:
- Name: Ein eindeutiger, logischer Servername.
- Beispiel: SuccessFactors
- Typ: SuccessFactors
-
URL:
{OData Endpoint}Example: https://api8.successfactors.com/odata/v2 -
Beispiel:
https://api8.successfactors.com/odata/v2 - Sicherheitsanbieter:
{Security Provider Name}
-
Klicken Sie auf die Schaltfläche Speichern
Sobald der Datenquellenserver registriert ist, klicken Sie auf die Schaltfläche Verbindung testen, um sicherzustellen, dass alles korrekt konfiguriert ist. Möglicherweise werden Sie jetzt aufgefordert, sich bei Okta anzumelden.
Fehlerbehebung
Eine Liste der SuccessFactors OAuth 2.0-Fehlerantworten finden Sie auf der folgenden Seite:
http://help.sap.com/saphelpiis_cloud4hr/EN/SuccessFactors_HCM_Suite_OData_API_Handbook_en.pdf
Der folgende Anhang „OAuth 2.0-bezogene Fehlermeldungen“ enthält weitere Fehler:
Weitere Informationen zur Fehlerbehebung finden Sie im Folgenden:
Sicherheitsanbieter - SuccessFactors OData
„Entweder ist der Server nicht verfügbar oder die Verbindungsinformationen sind falsch.“ beim Testen der Verbindung
Stellen Sie sicher, dass die URL des Datenquellenservers mit einem Schrägstrich endet. Beispiel:
https://api8.successfactors.com/odata/v2/
Seit März 2016 erfordert SuccessFactors einen abschließenden Schrägstrich.
„Der Zugriff auf die OData API mithilfe der Basisauthentifizierung oder externem OAuth auf Nicht-API -Servern ist verboten.“ beim Testen der Verbindung
Möglicherweise wurde der API Endpoint durch einen neuen Endpoint ersetzt. Beispielsweise wurden die folgenden Endpoints ersetzt:
- Im November 2015 wurde der API Endpoint
https://salesdemo4.successfactors.com/wurde ersetzt durchhttps://apisalesdemo4.successfactors.com/. - Im März 2016 wurde der API Endpoint
https://hcm8preview.sapsf.com/wurde ersetzt durchhttps://api8preview.sapsf.com/.