Scribd
Upload
55 views

API User Creation

Uploaded by

Suresh T
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
55 views

API User Creation

Uploaded by

Suresh T
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

01/02/2024, 22:52 about:blank

Creating and configuring an API user for SuccessFactors APIs

Creating a new API user


Note: if you already have the API user created and you just need assistance configuring it, you can skip these steps and go to
the next pages.

In order to create a new API user, you can use the "Import Employee Data" tool. You would need to follow these steps:

1. Go to Admin Center > "Import Employee Data" tool.


2. Select the action "Download Template".
3. Choose "Basic Import" as the entity.
4. Click on "Generate Template" to download the CSV file that will be used as the import file.

5. Provide the required fields in the CSV file (refer to the KBA 2267907 - Employee Import/Export file: supported
standard-elements fields).
6. Go back to "Import Employee Data" tool and select the action as "Import Data".
7. Select the entity as "Basic Import" and choose the CSV file you built previously.
8. Click on the "Validate Import File Data" button before actually importing it to confirm if there's not any problems with
the file.

about:blank 1/4
01/02/2024, 22:52 about:blank

9. After that, click on "Import" to effectively import the data.

SFAPI

OData API (V2)

SCIM API

SFAPI

What is SFAPI?
SFAPI is a SOAP based web service that exposes the data from the SuccessFactors objects so it can be consumed by external
systems, the Help Portal page Introduction provides more details about it.

Important note: all the SFAPI objects are currently deprecated, meaning that no enhancements or new features will be
delivered for this API anymore. More details in the Help Portal page Deprecation of Partner API, SFAPI Adhoc, and SFAPI for
Simple Entities. This deprecation, however, doesn't affect Compound Employee API, which also uses SFAPI.

HTTP Basic Authentication (Deprecated)

OAuth 2.0

about:blank 2/4
01/02/2024, 22:52 about:blank

HTTP Basic Authentication (SFAPI)

What is HTTP Basic Authentication?


HTTP Basic Authentication consists on logging into the API using a username and password. It's currently a deprecated
method, which is planned to be replaced by OAuth 2.0 in the future, more details on Deprecation of HTTP Basic
Authentication for APIs.

How does it work in SFAPI?

In SFAPI, the Basic Authentication is performed through the Login operation. For more details please refer to the "Testing
SFAPI with Basic Authentication" section of the KBA 2320264.

Permissions required to use HTTP Basic Authentication


Your API user requires the following permission:

General User Permissions > SFAPI User Login

Please grant this permission to the API user.

Available SFAPI entities and its permissions

SFAPI entities and its permissions

about:blank 3/4
01/02/2024, 22:52 about:blank
This page lists all the available SFAPI entities, please confirm which one your API user will have to access and refer to their
respective documentation links in order to review what are their permissions in RBP.

Deprecated SFAPI entities


The following entities are considered deprecated and we don't recommend you to use them anymore:

Adhoc Reports API


Entities from EC (EmpJob for example)
Entities from other modules, Recruiting for example

The User entity is also deprecated and not recommended to be used, but it is still covered in the guide page User Entity -
Permissions.

Compound Employee API

Compound Employee API is the only SFAPI entity that is not deprecated.

In order to review which permissions are required to access it, refer to the guide pages:

Granting Permissions for Full Access to the CompoundEmployee API


Granting Permissions for Restricted Access to the CompoundEmployee API
Granting Permissions for Segment Access to the CompoundEmployee API

about:blank 4/4

You might also like