Sap successfactors

Learn how to use Sap successfactors with Composio

Overview

SLUG: SAP_SUCCESSFACTORS

Description

Cloud-based human capital management software covering Employee Central, Recruiting, Performance & Goals, Learning, Compensation, and more.

Authentication Details

full
stringRequired
authorizationUrl
stringRequired
company_id
stringRequired
client_id
stringRequired
private_key
stringRequired
user_id
stringRequired

Connecting to Sap successfactors

Create an auth config

Use the dashboard to create an auth config for the Sap successfactors toolkit. This allows you to connect multiple Sap successfactors accounts to Composio for agents to use.

1

Select App

Navigate to [Sap successfactors](https://platform.composio.dev?next_page=/marketplace/Sap successfactors).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Sap successfactors Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Saml

1# Template not found: templates/python/saml.py

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Sap successfactors toolkit’s playground](https://app.composio.dev/app/Sap successfactors)

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Approve Calibration Session

Description

Finalize a calibration session that is in the In Progress or Approving status.

Action Parameters

comments
string
session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a Feedback Request

Description

Create a feedback request in SAP SuccessFactors Continuous Feedback. Use when you need to request performance feedback from one employee about another. At least one question must be provided.

Action Parameters

question1
string
question2
string
question3
string
recipientAssignmentUUID
stringRequired
requestText
string
requesterAssignmentUUID
stringRequired
subjectUserAssignmentUUID
stringRequired
topic
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Learning Activities Bulk

Description

Create learning activities and associate them with development goals in bulk (requires third-party LMS integration).

Action Parameters

activities
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create or Update Successor Nomination

Description

Create or update a successor nomination for a position or talent pool in succession planning. Use when you need to nominate or update a successor for a specific position or talent pool.

Action Parameters

emergency_cover
boolean
is_pool_nomination
booleanRequired
nomination_target
stringRequired
note
string
rank
integer
readiness
number
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Nomination

Description

Delete a nomination for a position or talent pool in succession planning. Use when you need to remove a nominee from a position or talent pool nomination.

Action Parameters

is_pool_nomination
booleanRequired
nomination_target
stringRequired
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Calibration Session By ID

Description

Get a specific calibration session by session ID.

Action Parameters

expand
string
select
string
session_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Calibration Sessions

Description

Query all the calibration sessions that a user can access.

Action Parameters

filter
string
orderby
string
select
string
skip
integer
top
integerDefaults to 100

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Calibration Subject By ID

Description

Query a specific subject's competency ratings and ratings within a calibration session.

Action Parameters

expand
string
select
string
session_id
stringRequired
subject_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Calibration Subject Ratings

Description

Query a subject's ratings, competency ratings, and comments by using session ID.

Action Parameters

filter
string
select
string
session_id
stringRequired
skip
integer
top
integerDefaults to 100

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get CDP Learning Metadata

Description

Get metadata for Career Development Planning Learning service.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Retrieves the currently authenticated user's information from SAP SuccessFactors.

Action Parameters

select_fields
stringDefaults to userId,username,defaultFullName,email

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Feedback Records

Description

Tool to retrieve continuous feedback records from SAP SuccessFactors Performance and Goals module using OData V4 protocol. Use when you need to query and retrieve feedback data with filtering, sorting, pagination, and field selection capabilities. Supports standard OData v4 query operations for flexible data retrieval.

Action Parameters

count
boolean
expand
string
filter
string
orderby
string
select
string
skip
integer
top
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Calibration Session Metadata

Description

Get OData metadata for Calibration Session service. Returns the service metadata including available entity sets. Use this to discover available entities in the CalSession.svc service.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Clock In/Out Integration Metadata

Description

Get OData metadata for Clock In/Clock Out Integration service. Returns the complete service schema including entity types, enum types, complex types, and entity container definitions.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Nomination Service Metadata

Description

Get OData metadata for Nomination service. Returns the service metadata including available entity sets for successor and talent pool nominations. Use this to discover available entities in the NominationService.svc service.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Onboarding Additional Services Metadata

Description

Get OData metadata for Onboarding Additional Services. Returns the complete service schema including available operations like updateUserNamePostHiring and getUserNameOfNewlyHiredEmployee.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Pending Feedback Requests

Description

Tool to retrieve pending feedback requests or feedback request records from SAP SuccessFactors Continuous Feedback. Use when you need to query feedback requests with filtering, sorting, pagination, and field selection capabilities. Supports standard OData v4 query operations for flexible data retrieval.

Action Parameters

count
boolean
expand
string
filter
string
orderby
string
select
string
skip
integer
top
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Give Feedback or Respond to Feedback Request

Description

Tool to give performance feedback or respond to a feedback request in SAP SuccessFactors Continuous Performance Management. Use when you need to provide feedback on employee performance, strengths, development areas, or respond to existing feedback requests. Supports up to 3 question-answer pairs with extended field lengths (4000 characters per answer).

Action Parameters

answer1
stringRequired
answer2
string
answer3
string
feedbackRequestRecordId
string
question1
stringRequired
question2
string
question3
string
senderUserAssignmentUUID
stringRequired
subjectUserAssignmentUUID
stringRequired
topic
stringRequired
visibleToManager
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query Clock In/Clock Out Group By Code

Description

Query a clock in/clock out group by code with time event types. Use when you need to retrieve details of a specific Clock In Clock Out Group including its configuration and optionally related Time Event Types.

Action Parameters

code
stringRequired
expand
string
select
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query All Available Clock In/Clock Out Groups

Description

Query all available clock in/clock out groups. Use when you need to retrieve a list of all clock in/clock out groups configured in SAP SuccessFactors.

Action Parameters

filter
string
orderby
string
select
string
skip
integer
top
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Refresh CDP Learning Metadata

Description

Refresh metadata for Career Development Planning Learning service.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Refresh Metadata for Continuous Feedback

Description

Refresh metadata cache for Continuous Feedback service. Use when metadata changes need to be applied without service interruption.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Calibration Subject Ratings

Description

Update a subject's competency ratings in a calibration session.

Action Parameters

calibrated
boolean
session_id
stringRequired
subject_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Username Post Hiring

Description

Update the internal username of new hires after hiring process is completed from Active Directory. Use after Manage Pending Hire (MPH) submit and before day 1 (pre-conversion). Requires 'Manage Onboarding 2.0 or Offboarding 2.0 Update New Hire Data for External HRIS' permission.

Action Parameters

user_id
stringRequired
user_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired