Update a connector version to allow your provisioning system to use a new API.
When an SAP cloud solution or service provides a new API for integrating with Identity Provisioning, you can update your respective connector (provisioning system) to use this API by configuring a version property and replacing its transformations.
For example, SAP Sales Cloud and SAP Service Cloud (formerly known as SAP Cloud for Customer) initially provided two SOAP-based APIs for integrating with Identity Provisioning and later introduced a SCIM-based API. Likewise, Identity Authentication service initially provided a SCIM-based API and later introduced an Identity Directory SCIM API.
Version property set to 1
means that your connector is using the initial API. You can continue using it as-is or update your connector to a new version.
Before updating your connector to a new version, it is always a good practice to export the system for backup purposes. See: Export and Import Systems
To update your connector to use a new API, proceed as follows:
-
Access the Identity Provisioning UI and choose a tile – Source Systems, Target Systems, or Proxy Systems.
Sign in to the administration console of SAP Cloud Identity Services and navigate to Identity Provisioning > Source Systems, Target Systems or Proxy Systems.
-
From the list on the left, select a system.
-
On the Properties tab, configure the following:
-
Version Property - Add or update the
<system_prefix>.api.version
property and set its value accordingly.Connector
Property
Value
Identity Authentication
ias.api.version
-
1
- Identity Authentication SCIM API (in short, SCIM API version 1)When the property is not defined - Identity Authentication SCIM API is used.
-
2
- Identity Directory SCIM API (in short, SCIM API version 2)
SAP Concur
concur.api.version
-
1
- SAP Concur API (Version 1)When the property is not defined - SAP Concur API is used.
-
2
- SAP Concur SCIM API (Version 2)
SAP Sales Cloud and SAP Service Cloud
c4c.api.version
-
1
- Version 1 (SOAP-based API)The SOAP-based API version 1 is depricated.
-
2
- Version 2 (SOAP-based API) -
3
- Version 3 (SCIM 2.0 based API)
SAP SuccessFactors
sf.api.version
-
1
- SAP SuccessFactors HCM Suite OData API (Version 1)When the property is not defined - SAP SuccessFactors HCM Suite OData API is used.
-
2
- SAP SuccessFactors Workforce SCIM API (Version 2)
SAP Analytics Cloud
sac.api.version
-
1
- SAP Analytics Cloud SCIM API version 1. This is the default value. -
2
- SAP Analytics Cloud SCIM API version 2
LDAP Server
ldap.api.version
-
1- LDAP Server API version 1 is used. This is the default value.
-
2 - LDAP Server API version 2 is used.
Microsoft Active Directory
ldap.api.version
-
1- LDAP API version 1 is used. This is the default value.
-
2 - LDAP API version 2 is used.
-
-
Properties with Version-Specific Values - Update connector properties which have version-specific values.
Connector
Property
Value
SAP SuccessFactors
URL
-
Version 1:
https://apitest.successfactors.com/odata/v2
-
Version 2:
https://apitest.successfactors.com
sf.user.filter
-
Version 1:
username eq 'cbraun'
status eq 'active'
-
Version 2:
userName eq "cbraun"
active eq true
SAP Analytics Cloud
csrf.token.path
-
Version 1:
/api/v1/scim/Users?count=1
-
Version 2:
/api/v1/scim2/Users?count=1
-
-
-
On the Transformations tab, if you've customized your transformation logic, copy and save it first, and then replace it with the default transformation provided for the respective API version. Use the Identity Provisioning connector documentation as a source of information for the transformation you need.
-
Reset the system to clear the operational data. It is assumed that you have already run provisioning jobs to target systems.
-
If you reset a target system, set the
ips.delete.existedbefore.entities
to true in the target system itself. This ensures that, if from now on you delete entities in the source system that is connected to your target system, those entities will be recognized as previously existed entities in the target system and will be deleted there. -
If you reset a source system, set the
ips.delete.existedbefore.entities
to true in every target system connected to the given source system. This ensures that, if from now on you delete entities in the source system that is connected to your target system, those entities will be recognized as previously existed entities in the target system and will be deleted there.
-
-
Adapt your new transformation, that is, apply the customizations from your previous transformation.
-
Save your changes and run a provisioning job.
Related Information
Start and Stop Provisioning Jobs