Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

Limitations and Known Issues

None.

...

Account Settings

<Insert image here><Update the image with values once it is available in the UI.>

...

Note

Field names marked with an asterisk ( * ) are mandatory.

Field Name

Field Type

Description

Label*

String

Unique A unique name for the account.

Default Value: [None]
ExampleSAP SuccessFactors Account

Host server

String

Specify the address of the host server to connect. Alternatively, click the Suggestions (blue star) icon to select a public host server from the suggestions bubble. 

Default Value: N/A
Example: apisalesdemo4.successfactors.com

DC4 SalesDemo: Chandler, Arizona, U.S.A (apisalesdemo4.successfactors.com)

Company ID

String

The Specify the SuccessFactors company id.

Default Value: N/A
Example: SFPART123456 

User name

String

Specify the SuccessFactors user name.

Default Value: N/A
Example: sfadmin

API key

String

Specify the API key of your OAuth 2.0 client application created in SuccessFactors portal.

To get an API key and Private key, see Configuration of OAuth 2.0 Client Application in SuccessFactors or SuccessFactors Developer Guide

Private key

String

Specify the private key of the X509.certificate that corresponds to your OAuth 2.0 client application created in SuccessFactors portal.

To get an API key and Private key, please follow the steps in the article see Configuration of OAuth 2.0 Client Application in SuccessFactors or SuccessFactors Developer Guide.

...

Error

Reason

Resolution

Company <company id>not found.

  • Wrong user name which is used. 

  • The wrong host server is selected or entered.

  • Ensure you have entered the correct company ID. Note that the company ID is case-sensitive.

  • Check if the host server you selected or entered is the correct one that matches your company ID. 

Unable to authenticate the client (login failed - invalid user).

You have entered an invalid user name.

Ensure that you enter the correct user name.

API key "<api key>" does not exist in company "<company id>".

You have entered an invalid value in the Company ID.

Log in to the API center and check if the Company ID you entered is invalid. 

The X.509 private key contains an error.

You have entered an invalid private key.

Log in to the API center and check if the private key you entered is valid. 

...