Tchater maintenant avec le support
Tchattez avec un ingénieur du support

Starling Connect Hosted - One Identity Manager Administration Guide

About this guide One Identity Starling Connect overview One Identity Starling Supported cloud applications Working with connectors Connector versions Salesforce Facebook Workplace SAP Cloud Platform JIRA Server RSA Archer SuccessFactors AWS IAM ServiceNow Dropbox Crowd Atlassian JIRA Confluence Trello Box Pipedrive SuccessFactors HR NutShell Insightly Egnyte SugarCRM Oracle IDCS Statuspage Zendesk Sell Workbooks DocuSign Citrix ShareFile Zendesk Azure AD Google Workspace Concur Tableau GoToMeeting Coupa AWS Cognito Okta DataDog Hideez Opsgenie Informatica Cloud Services AppDynamics Marketo Workday HR OneLogin PingOne Aha! SAP Litmos HackerRank Slack ActiveCampaign Webex Apigee Databricks Hive PagerDuty Dayforce Smartsheet Pingboard SAP Cloud for Customer Azure Infrastructure Oracle Fusion Cloud Majesco LuccaHR OpenText JFrog Artifactory xMatters Discourse Testrail ChipSoft PingOne Platform Azure DevOps UKG PRO Atlassian Cloud Appendix: Creating a service account in Google Workspace Appendix: Setting a trial account on Salesforce Registering the application, providing necessary permissions, retrieving Client Id and Client Secret from the Azure AD tenant Generating a private key for service account in GoToMeeting Configuring AWS IAM connector to support entitlements for User and Group Configuring Box connector to support additional email IDs for users One Identity Manager E2E integration needs for Hideez connector Configuring custom attributes for ServiceNow v.1.0 Configuring custom attributes for Coupa v.1.0 Configuring custom attributes in connectors Disabling attributes Configuring a connector that uses the consent feature Synchronization and integration of Roles object type with One Identity Manager Synchronization and integration of Workspaces object type with One Identity Manager Synchronization and integration of Products object type with One Identity Manager User centric membership Creating multi-valued custom fields in One Identity Manager Synchronization and assignment of PermissionSets to Users with One Identity Manager Connectors that support password attribute in User object Connectors that do not support special characters in the object ID Creating an app for using SCIM on Slack Enterprise Grid Organization Creating a Webex integration application, providing necessary scopes, retrieving Client Id and Client Secret Retrieving the API key from Facebook Workplace Outbound IP addresses Values for customer-specific configuration parameters in Workday HR connector Initiate an OAuth connection to SuccessFactors Creating custom editable/upsertable attributes in Successfactors employee central Custom Foundation Objects in Successfactors HR connector Configuring additional datetime offset in connectors How to Create custom attribute for Users in SuccessFactors portal SAP Cloud for Customer - Steps to add custom fields at One Identity Manager attributes Creating a Service Principal for the Azure Infrastructure Connector Workday permissions needed to integrate via the Starling Connector Configuring integration application in DocuSign Creating integration Connect Client in Coupa Retrieving Azure DevOps Personal Access Token (PAT) Setup integration system and field override service in Workday Retrieving Atlassian Cloud API Key and Directory ID Retrieving Tableau Personal Access Token (PAT)

Supported objects and operations

SuccessFactors is an integrated human-resources platform. It offers users tools for onboarding, social business, and collaboration along with tools for learning management, performance management, recruiting, applicant tracking, succession planning, talent management, and HR analytics. It is also cloud-based.

Supervisor configuration parameters

To configure the connector, following parameters are required:

Users

Table 35: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete (only till v3.0)

DELETE

Get User (Id)

GET

Get All Users

GET

Get All Users with pagination

GET

Groups

Table 36: Supported operations for Groups

Operation

VERB

Update Group PUT
Get All Groups GET

Get Groups (Id)

GET

Get All Groups with pagination GET

Mandatory fields

Users (v1.0-v3.0)

  • User Name
  • Employee Number
  • Status

Users v4.0

  • UserName

  • UserId

  • Status

User and Group mapping

The user and group mappings are listed in the tables below.

Table 37: User mapping
SCIM parameter SuccessFactors parameter
Id userId
UserName username
Name.GivenName firstName
Name.FamilyName lastName

Name.MiddleName

mi

Name.HonorificSuffix

suffix

Name.Formatted

defaultFullName

DisplayName defaultFullName
Emails.Value email
Addresses.StreetAddress addressLine1
Addresses.Locality city
Addresses.Region state

Addresses.PostalCode

zipCode

Addresses.Country

country

PhoneNumbers.Value

businessPhone

Groups.value

groupId

Groups.display

groupName

Roles.value

user.role.id

Roles.display

user.role.name

UserType

jobTitle

Title

title

Active

status

Locale

defaultLocale

Timezone

timeZone

userExtension.EmployeeNumber

empId

userExtension.Division

division

userExtension.Department

department

userExtension.Gender

gender

userExtension.HireDate

hireDate

userExtension.DateOfBirth

dateOfBirth

Meta.Created

hireDate

Meta.LastModified

lastModified

Table 38: Additional mapping from v4.0 onwards
SCIM parameter SuccessFactors parameter
Location location
UserExtension.UserId userId
userExtension.JobCode jobCode
userExtension.Custom01 custom01
userExtension.Custom02 custom02
userExtension.Custom03 custom03
userExtension.Custom04 custom04
userExtension.Custom05 custom05
userExtension.Custom06 custom06
userExtension.Custom07 custom07
userExtension.Custom08 custom08
userExtension.Custom09 custom09
userExtension.Custom10 custom10
userExtension.Custom11 custom11
userExtension.Custom12 custom12
userExtension.Custom13 custom13
userExtension.Custom14 custom14
userExtension.Custom15 custom15
userExtension.Hr.UserId hr.userId
userExtension.Hr.Email hr.email
userExtension.Hr.Username hr.username
userExtension.Hr.Active hr.status
userExtension.Manager.UserId manager.userId
userExtension.Manager.Email manager.email
userExtension.Manager.Username manager.username
userExtension.Manager.Active manager.status
Table 39: Group mapping
SCIM parameter SuccessFactors parameter
Id groupID
displayName groupName

members.value

userId

members.display

userName

groupExtension.groupType groupType
groupExtension.staticGroup staticGroup
Meta.LastModified lastModifiedDate

Connector limitations

  • Create and Delete group operations are not supported due to cloud application limitations.
  • When the active status is updated to false while performing the PUT operation for a user, the following error appears: user not found. This error occurs because a user is considered as a deleted user when the active status is false. (applicable for version V1 to V3)

  • User update does not support addition and removal of Groups or Roles for a particular user. It is done using group update. This is not applicable for role update.

  • Due to the API limitation of the target system, only the groups with type "permission" and "ectworkflow" are supported by version 3.0 of the connector.

  • User employee number cannot be updated because the cloud application considers employee number as a user Id. (applicable from version V1 till V3)

  • The UPDATE of Static Group supports the change of name and memberships. However, the UPDATE of Dynamic Group supports only the change of name but not the memberships. This is due to the target system behavior.

  • The manager/hr attribute gets added under user only if manager/hr in the request has the status as active.

  • Non-existing users should not be assigned as manager/hr while creating/updating user.

Disable attributes

The Disable attribute feature can be used when you want to skip an attribute that exists in the target system.

For the SuccessFactors connector, the attributes of the User object, including those of Enterprise User, can be disabled or enabled while configuring the connector based on your requirements.

NOTE:

  • Mandatory attributes cannot be disabled.
  • For more information about how to disable attributes in Starling Connect, see Disabling attributes in the Appendix section.

Connector versions and features

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in SuccessFactors v.1.0

Following are the features that are available exclusively in SuccessFactorsv.1.0:

  • Update of basic attributes on Static and Dynamic Groups are supported.

  • Update of Group membership on Static and Dynamic Groups are supported.

  • Update of Dynamic Groups will remove the associated Dynamic Clauses.

  • Supported insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.2.0

Following are the features that are available exclusively in SuccessFactors v.2.0:

  • Update of basic attributes on Dynamic Groups are supported.

  • Update of Group membership on Static Groups are supported.

  • Dynamic Group supports group basic attributes update, but not group memberships.

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Static Group Update (supports only Add and Remove operations for Group Members)
  • Dynamic Group Update (supports Group Update without removing the existing dynamic clauses)

    NOTE:

    • These features are available from version 2.0 onwards.
    • In version 1.0, only Dynamic Group Update is supported. Static Group Update is not supported in version 1.0.
    • Version 2.0 is enhanced to allow you to use the Dynamic Group Update operation to update the attributes of a Dynamic Group without removing the dynamic clause that you have added for that Dynamic Group.

      This feature is available from version 2.0 onwards. In version 1.0 of the connector, the Dynamic Group Update function removes the existing dynamic clause that was added for the Dynamic Group.

Features available exclusively in SuccessFactors v.3.0

Following are the features that are available exclusively in SuccessFactorsv.3.0:

  • Supports all the features from v2.0.

  • Synchronization has been improved by limiting the groups type to ‘Permission’ and ‘ectworkflow’.

  • Supports insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.4.0

Following are the features that are available exclusively in SuccessFactorsv.4.0:

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Additional attributes ( userId, jobCode, location, All available "CustomXX", hr(complex), manager(complex) ) supported under users.

  • Setting up a custom unique UserID on CREATE is supported.

  • DELETE operation not supported in Users endpoint.

  • Supported Custom Attributes for Users. Refer How to create custom attributes for users in Successfactors portal

Features available exclusively in SuccessFactors v.5.0

Following are the features that are available exclusively in SuccessFactorsv.5.0:

  • v.5.0 has no feature change only addition is that it supports OAuth Authentication.
  • For detailed explanation on setting up OAuth Authentication, refer SetUp OAuth.

  • Supported an additional parameter apiOptionProfileID as a config field while Create/update users.

Support for filter condition

SuccessFactors connector supports filter condition for User objects. Filter condition can be applied, and the Users can be retrieved selectively. Based on the supported operators and values provided at the filter the User objects are returned in the response from the connector.

To configure changes to One Identity Manager to support filter conditions

  1. Open the Synchronization Editor tool.

  2. Select SCIM connector.

  3. Select the Target system and navigate to Schema Classes.

    For example - id ne '10056' AND (locale eq 'Cleveland (1000-2011)')

  4. Add a new schema class for the user.

  5. Add the System filter and Select Object condition.

    Click Commit to Database.

  6. In User mappings, create or edit the Target system schema class with the recently created schema and click Commit to Database.

  7. Run the synchronization.

  8. Filter conditions are created.

Supported attributes for filter

  • id
  • userName
  • lastModified
  • meta.lastModified
  • givenName
  • familyName
  • division
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division
  • department
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department

NOTE:

  • The connector supports filter condition in all versions but only for User objects.

  • Supports only AND and OR logical operators.

  • Supports only parenthesis () for grouping the condition.

  • Unsupported attributes in the filter request will be ignored, no error will be thrown.

  • Only the sub-attributes of a complex attribute are supported in filter condition. For example, givenName or familyName

Table 40: Supported operators to filter values
S. No

Operators

OneIM System Filters

OneIM Select Objects

1

eq → equal to

lastModified eq 2020-08-27T15:22:52

lastModified = 2020-08-27T15:22:52

2

ne → not equal to

lastModified ne 2020-08-27T15:22:52

lastModified <> 2020-08-27T15:22:52

3

gt → greater than

lastModified gt 2020-08-27T15:22:52

lastModified > 2020-08-27T15:22:52

4

lt → less than

lastModified lt 2020-08-27T15:22:52

lastModified < 2020-08-27T15:22:52

5

ge → greater than or equal to

lastModified ge 2020-08-27T15:22:52

lastModified >= 2020-08-27T15:22:52

6

le → less than or equal to

lastModified le 2020-08-27T15:22:52

lastModified <= 2020-08-27T15:22:52

Mandatory fields

SuccessFactors is an integrated human-resources platform. It offers users tools for onboarding, social business, and collaboration along with tools for learning management, performance management, recruiting, applicant tracking, succession planning, talent management, and HR analytics. It is also cloud-based.

Supervisor configuration parameters

To configure the connector, following parameters are required:

Supported objects and operations

Users

Table 35: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete (only till v3.0)

DELETE

Get User (Id)

GET

Get All Users

GET

Get All Users with pagination

GET

Groups

Table 36: Supported operations for Groups

Operation

VERB

Update Group PUT
Get All Groups GET

Get Groups (Id)

GET

Get All Groups with pagination GET

Users (v1.0-v3.0)

  • User Name
  • Employee Number
  • Status

Users v4.0

  • UserName

  • UserId

  • Status

User and Group mapping

The user and group mappings are listed in the tables below.

Table 37: User mapping
SCIM parameter SuccessFactors parameter
Id userId
UserName username
Name.GivenName firstName
Name.FamilyName lastName

Name.MiddleName

mi

Name.HonorificSuffix

suffix

Name.Formatted

defaultFullName

DisplayName defaultFullName
Emails.Value email
Addresses.StreetAddress addressLine1
Addresses.Locality city
Addresses.Region state

Addresses.PostalCode

zipCode

Addresses.Country

country

PhoneNumbers.Value

businessPhone

Groups.value

groupId

Groups.display

groupName

Roles.value

user.role.id

Roles.display

user.role.name

UserType

jobTitle

Title

title

Active

status

Locale

defaultLocale

Timezone

timeZone

userExtension.EmployeeNumber

empId

userExtension.Division

division

userExtension.Department

department

userExtension.Gender

gender

userExtension.HireDate

hireDate

userExtension.DateOfBirth

dateOfBirth

Meta.Created

hireDate

Meta.LastModified

lastModified

Table 38: Additional mapping from v4.0 onwards
SCIM parameter SuccessFactors parameter
Location location
UserExtension.UserId userId
userExtension.JobCode jobCode
userExtension.Custom01 custom01
userExtension.Custom02 custom02
userExtension.Custom03 custom03
userExtension.Custom04 custom04
userExtension.Custom05 custom05
userExtension.Custom06 custom06
userExtension.Custom07 custom07
userExtension.Custom08 custom08
userExtension.Custom09 custom09
userExtension.Custom10 custom10
userExtension.Custom11 custom11
userExtension.Custom12 custom12
userExtension.Custom13 custom13
userExtension.Custom14 custom14
userExtension.Custom15 custom15
userExtension.Hr.UserId hr.userId
userExtension.Hr.Email hr.email
userExtension.Hr.Username hr.username
userExtension.Hr.Active hr.status
userExtension.Manager.UserId manager.userId
userExtension.Manager.Email manager.email
userExtension.Manager.Username manager.username
userExtension.Manager.Active manager.status
Table 39: Group mapping
SCIM parameter SuccessFactors parameter
Id groupID
displayName groupName

members.value

userId

members.display

userName

groupExtension.groupType groupType
groupExtension.staticGroup staticGroup
Meta.LastModified lastModifiedDate

Connector limitations

  • Create and Delete group operations are not supported due to cloud application limitations.
  • When the active status is updated to false while performing the PUT operation for a user, the following error appears: user not found. This error occurs because a user is considered as a deleted user when the active status is false. (applicable for version V1 to V3)

  • User update does not support addition and removal of Groups or Roles for a particular user. It is done using group update. This is not applicable for role update.

  • Due to the API limitation of the target system, only the groups with type "permission" and "ectworkflow" are supported by version 3.0 of the connector.

  • User employee number cannot be updated because the cloud application considers employee number as a user Id. (applicable from version V1 till V3)

  • The UPDATE of Static Group supports the change of name and memberships. However, the UPDATE of Dynamic Group supports only the change of name but not the memberships. This is due to the target system behavior.

  • The manager/hr attribute gets added under user only if manager/hr in the request has the status as active.

  • Non-existing users should not be assigned as manager/hr while creating/updating user.

Disable attributes

The Disable attribute feature can be used when you want to skip an attribute that exists in the target system.

For the SuccessFactors connector, the attributes of the User object, including those of Enterprise User, can be disabled or enabled while configuring the connector based on your requirements.

NOTE:

  • Mandatory attributes cannot be disabled.
  • For more information about how to disable attributes in Starling Connect, see Disabling attributes in the Appendix section.

Connector versions and features

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in SuccessFactors v.1.0

Following are the features that are available exclusively in SuccessFactorsv.1.0:

  • Update of basic attributes on Static and Dynamic Groups are supported.

  • Update of Group membership on Static and Dynamic Groups are supported.

  • Update of Dynamic Groups will remove the associated Dynamic Clauses.

  • Supported insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.2.0

Following are the features that are available exclusively in SuccessFactors v.2.0:

  • Update of basic attributes on Dynamic Groups are supported.

  • Update of Group membership on Static Groups are supported.

  • Dynamic Group supports group basic attributes update, but not group memberships.

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Static Group Update (supports only Add and Remove operations for Group Members)
  • Dynamic Group Update (supports Group Update without removing the existing dynamic clauses)

    NOTE:

    • These features are available from version 2.0 onwards.
    • In version 1.0, only Dynamic Group Update is supported. Static Group Update is not supported in version 1.0.
    • Version 2.0 is enhanced to allow you to use the Dynamic Group Update operation to update the attributes of a Dynamic Group without removing the dynamic clause that you have added for that Dynamic Group.

      This feature is available from version 2.0 onwards. In version 1.0 of the connector, the Dynamic Group Update function removes the existing dynamic clause that was added for the Dynamic Group.

Features available exclusively in SuccessFactors v.3.0

Following are the features that are available exclusively in SuccessFactorsv.3.0:

  • Supports all the features from v2.0.

  • Synchronization has been improved by limiting the groups type to ‘Permission’ and ‘ectworkflow’.

  • Supports insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.4.0

Following are the features that are available exclusively in SuccessFactorsv.4.0:

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Additional attributes ( userId, jobCode, location, All available "CustomXX", hr(complex), manager(complex) ) supported under users.

  • Setting up a custom unique UserID on CREATE is supported.

  • DELETE operation not supported in Users endpoint.

  • Supported Custom Attributes for Users. Refer How to create custom attributes for users in Successfactors portal

Features available exclusively in SuccessFactors v.5.0

Following are the features that are available exclusively in SuccessFactorsv.5.0:

  • v.5.0 has no feature change only addition is that it supports OAuth Authentication.
  • For detailed explanation on setting up OAuth Authentication, refer SetUp OAuth.

  • Supported an additional parameter apiOptionProfileID as a config field while Create/update users.

Support for filter condition

SuccessFactors connector supports filter condition for User objects. Filter condition can be applied, and the Users can be retrieved selectively. Based on the supported operators and values provided at the filter the User objects are returned in the response from the connector.

To configure changes to One Identity Manager to support filter conditions

  1. Open the Synchronization Editor tool.

  2. Select SCIM connector.

  3. Select the Target system and navigate to Schema Classes.

    For example - id ne '10056' AND (locale eq 'Cleveland (1000-2011)')

  4. Add a new schema class for the user.

  5. Add the System filter and Select Object condition.

    Click Commit to Database.

  6. In User mappings, create or edit the Target system schema class with the recently created schema and click Commit to Database.

  7. Run the synchronization.

  8. Filter conditions are created.

Supported attributes for filter

  • id
  • userName
  • lastModified
  • meta.lastModified
  • givenName
  • familyName
  • division
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division
  • department
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department

NOTE:

  • The connector supports filter condition in all versions but only for User objects.

  • Supports only AND and OR logical operators.

  • Supports only parenthesis () for grouping the condition.

  • Unsupported attributes in the filter request will be ignored, no error will be thrown.

  • Only the sub-attributes of a complex attribute are supported in filter condition. For example, givenName or familyName

Table 40: Supported operators to filter values
S. No

Operators

OneIM System Filters

OneIM Select Objects

1

eq → equal to

lastModified eq 2020-08-27T15:22:52

lastModified = 2020-08-27T15:22:52

2

ne → not equal to

lastModified ne 2020-08-27T15:22:52

lastModified <> 2020-08-27T15:22:52

3

gt → greater than

lastModified gt 2020-08-27T15:22:52

lastModified > 2020-08-27T15:22:52

4

lt → less than

lastModified lt 2020-08-27T15:22:52

lastModified < 2020-08-27T15:22:52

5

ge → greater than or equal to

lastModified ge 2020-08-27T15:22:52

lastModified >= 2020-08-27T15:22:52

6

le → less than or equal to

lastModified le 2020-08-27T15:22:52

lastModified <= 2020-08-27T15:22:52

Connector limitations

SuccessFactors is an integrated human-resources platform. It offers users tools for onboarding, social business, and collaboration along with tools for learning management, performance management, recruiting, applicant tracking, succession planning, talent management, and HR analytics. It is also cloud-based.

Supervisor configuration parameters

To configure the connector, following parameters are required:

Supported objects and operations

Users

Table 35: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete (only till v3.0)

DELETE

Get User (Id)

GET

Get All Users

GET

Get All Users with pagination

GET

Groups

Table 36: Supported operations for Groups

Operation

VERB

Update Group PUT
Get All Groups GET

Get Groups (Id)

GET

Get All Groups with pagination GET

Mandatory fields

Users (v1.0-v3.0)

  • User Name
  • Employee Number
  • Status

Users v4.0

  • UserName

  • UserId

  • Status

User and Group mapping

The user and group mappings are listed in the tables below.

Table 37: User mapping
SCIM parameter SuccessFactors parameter
Id userId
UserName username
Name.GivenName firstName
Name.FamilyName lastName

Name.MiddleName

mi

Name.HonorificSuffix

suffix

Name.Formatted

defaultFullName

DisplayName defaultFullName
Emails.Value email
Addresses.StreetAddress addressLine1
Addresses.Locality city
Addresses.Region state

Addresses.PostalCode

zipCode

Addresses.Country

country

PhoneNumbers.Value

businessPhone

Groups.value

groupId

Groups.display

groupName

Roles.value

user.role.id

Roles.display

user.role.name

UserType

jobTitle

Title

title

Active

status

Locale

defaultLocale

Timezone

timeZone

userExtension.EmployeeNumber

empId

userExtension.Division

division

userExtension.Department

department

userExtension.Gender

gender

userExtension.HireDate

hireDate

userExtension.DateOfBirth

dateOfBirth

Meta.Created

hireDate

Meta.LastModified

lastModified

Table 38: Additional mapping from v4.0 onwards
SCIM parameter SuccessFactors parameter
Location location
UserExtension.UserId userId
userExtension.JobCode jobCode
userExtension.Custom01 custom01
userExtension.Custom02 custom02
userExtension.Custom03 custom03
userExtension.Custom04 custom04
userExtension.Custom05 custom05
userExtension.Custom06 custom06
userExtension.Custom07 custom07
userExtension.Custom08 custom08
userExtension.Custom09 custom09
userExtension.Custom10 custom10
userExtension.Custom11 custom11
userExtension.Custom12 custom12
userExtension.Custom13 custom13
userExtension.Custom14 custom14
userExtension.Custom15 custom15
userExtension.Hr.UserId hr.userId
userExtension.Hr.Email hr.email
userExtension.Hr.Username hr.username
userExtension.Hr.Active hr.status
userExtension.Manager.UserId manager.userId
userExtension.Manager.Email manager.email
userExtension.Manager.Username manager.username
userExtension.Manager.Active manager.status
Table 39: Group mapping
SCIM parameter SuccessFactors parameter
Id groupID
displayName groupName

members.value

userId

members.display

userName

groupExtension.groupType groupType
groupExtension.staticGroup staticGroup
Meta.LastModified lastModifiedDate
  • Create and Delete group operations are not supported due to cloud application limitations.
  • When the active status is updated to false while performing the PUT operation for a user, the following error appears: user not found. This error occurs because a user is considered as a deleted user when the active status is false. (applicable for version V1 to V3)

  • User update does not support addition and removal of Groups or Roles for a particular user. It is done using group update. This is not applicable for role update.

  • Due to the API limitation of the target system, only the groups with type "permission" and "ectworkflow" are supported by version 3.0 of the connector.

  • User employee number cannot be updated because the cloud application considers employee number as a user Id. (applicable from version V1 till V3)

  • The UPDATE of Static Group supports the change of name and memberships. However, the UPDATE of Dynamic Group supports only the change of name but not the memberships. This is due to the target system behavior.

  • The manager/hr attribute gets added under user only if manager/hr in the request has the status as active.

  • Non-existing users should not be assigned as manager/hr while creating/updating user.

Disable attributes

The Disable attribute feature can be used when you want to skip an attribute that exists in the target system.

For the SuccessFactors connector, the attributes of the User object, including those of Enterprise User, can be disabled or enabled while configuring the connector based on your requirements.

NOTE:

  • Mandatory attributes cannot be disabled.
  • For more information about how to disable attributes in Starling Connect, see Disabling attributes in the Appendix section.

Connector versions and features

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in SuccessFactors v.1.0

Following are the features that are available exclusively in SuccessFactorsv.1.0:

  • Update of basic attributes on Static and Dynamic Groups are supported.

  • Update of Group membership on Static and Dynamic Groups are supported.

  • Update of Dynamic Groups will remove the associated Dynamic Clauses.

  • Supported insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.2.0

Following are the features that are available exclusively in SuccessFactors v.2.0:

  • Update of basic attributes on Dynamic Groups are supported.

  • Update of Group membership on Static Groups are supported.

  • Dynamic Group supports group basic attributes update, but not group memberships.

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Static Group Update (supports only Add and Remove operations for Group Members)
  • Dynamic Group Update (supports Group Update without removing the existing dynamic clauses)

    NOTE:

    • These features are available from version 2.0 onwards.
    • In version 1.0, only Dynamic Group Update is supported. Static Group Update is not supported in version 1.0.
    • Version 2.0 is enhanced to allow you to use the Dynamic Group Update operation to update the attributes of a Dynamic Group without removing the dynamic clause that you have added for that Dynamic Group.

      This feature is available from version 2.0 onwards. In version 1.0 of the connector, the Dynamic Group Update function removes the existing dynamic clause that was added for the Dynamic Group.

Features available exclusively in SuccessFactors v.3.0

Following are the features that are available exclusively in SuccessFactorsv.3.0:

  • Supports all the features from v2.0.

  • Synchronization has been improved by limiting the groups type to ‘Permission’ and ‘ectworkflow’.

  • Supports insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.4.0

Following are the features that are available exclusively in SuccessFactorsv.4.0:

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Additional attributes ( userId, jobCode, location, All available "CustomXX", hr(complex), manager(complex) ) supported under users.

  • Setting up a custom unique UserID on CREATE is supported.

  • DELETE operation not supported in Users endpoint.

  • Supported Custom Attributes for Users. Refer How to create custom attributes for users in Successfactors portal

Features available exclusively in SuccessFactors v.5.0

Following are the features that are available exclusively in SuccessFactorsv.5.0:

  • v.5.0 has no feature change only addition is that it supports OAuth Authentication.
  • For detailed explanation on setting up OAuth Authentication, refer SetUp OAuth.

  • Supported an additional parameter apiOptionProfileID as a config field while Create/update users.

Support for filter condition

SuccessFactors connector supports filter condition for User objects. Filter condition can be applied, and the Users can be retrieved selectively. Based on the supported operators and values provided at the filter the User objects are returned in the response from the connector.

To configure changes to One Identity Manager to support filter conditions

  1. Open the Synchronization Editor tool.

  2. Select SCIM connector.

  3. Select the Target system and navigate to Schema Classes.

    For example - id ne '10056' AND (locale eq 'Cleveland (1000-2011)')

  4. Add a new schema class for the user.

  5. Add the System filter and Select Object condition.

    Click Commit to Database.

  6. In User mappings, create or edit the Target system schema class with the recently created schema and click Commit to Database.

  7. Run the synchronization.

  8. Filter conditions are created.

Supported attributes for filter

  • id
  • userName
  • lastModified
  • meta.lastModified
  • givenName
  • familyName
  • division
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division
  • department
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department

NOTE:

  • The connector supports filter condition in all versions but only for User objects.

  • Supports only AND and OR logical operators.

  • Supports only parenthesis () for grouping the condition.

  • Unsupported attributes in the filter request will be ignored, no error will be thrown.

  • Only the sub-attributes of a complex attribute are supported in filter condition. For example, givenName or familyName

Table 40: Supported operators to filter values
S. No

Operators

OneIM System Filters

OneIM Select Objects

1

eq → equal to

lastModified eq 2020-08-27T15:22:52

lastModified = 2020-08-27T15:22:52

2

ne → not equal to

lastModified ne 2020-08-27T15:22:52

lastModified <> 2020-08-27T15:22:52

3

gt → greater than

lastModified gt 2020-08-27T15:22:52

lastModified > 2020-08-27T15:22:52

4

lt → less than

lastModified lt 2020-08-27T15:22:52

lastModified < 2020-08-27T15:22:52

5

ge → greater than or equal to

lastModified ge 2020-08-27T15:22:52

lastModified >= 2020-08-27T15:22:52

6

le → less than or equal to

lastModified le 2020-08-27T15:22:52

lastModified <= 2020-08-27T15:22:52

Disable attributes

SuccessFactors is an integrated human-resources platform. It offers users tools for onboarding, social business, and collaboration along with tools for learning management, performance management, recruiting, applicant tracking, succession planning, talent management, and HR analytics. It is also cloud-based.

Supervisor configuration parameters

To configure the connector, following parameters are required:

Supported objects and operations

Users

Table 35: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete (only till v3.0)

DELETE

Get User (Id)

GET

Get All Users

GET

Get All Users with pagination

GET

Groups

Table 36: Supported operations for Groups

Operation

VERB

Update Group PUT
Get All Groups GET

Get Groups (Id)

GET

Get All Groups with pagination GET

Mandatory fields

Users (v1.0-v3.0)

  • User Name
  • Employee Number
  • Status

Users v4.0

  • UserName

  • UserId

  • Status

User and Group mapping

The user and group mappings are listed in the tables below.

Table 37: User mapping
SCIM parameter SuccessFactors parameter
Id userId
UserName username
Name.GivenName firstName
Name.FamilyName lastName

Name.MiddleName

mi

Name.HonorificSuffix

suffix

Name.Formatted

defaultFullName

DisplayName defaultFullName
Emails.Value email
Addresses.StreetAddress addressLine1
Addresses.Locality city
Addresses.Region state

Addresses.PostalCode

zipCode

Addresses.Country

country

PhoneNumbers.Value

businessPhone

Groups.value

groupId

Groups.display

groupName

Roles.value

user.role.id

Roles.display

user.role.name

UserType

jobTitle

Title

title

Active

status

Locale

defaultLocale

Timezone

timeZone

userExtension.EmployeeNumber

empId

userExtension.Division

division

userExtension.Department

department

userExtension.Gender

gender

userExtension.HireDate

hireDate

userExtension.DateOfBirth

dateOfBirth

Meta.Created

hireDate

Meta.LastModified

lastModified

Table 38: Additional mapping from v4.0 onwards
SCIM parameter SuccessFactors parameter
Location location
UserExtension.UserId userId
userExtension.JobCode jobCode
userExtension.Custom01 custom01
userExtension.Custom02 custom02
userExtension.Custom03 custom03
userExtension.Custom04 custom04
userExtension.Custom05 custom05
userExtension.Custom06 custom06
userExtension.Custom07 custom07
userExtension.Custom08 custom08
userExtension.Custom09 custom09
userExtension.Custom10 custom10
userExtension.Custom11 custom11
userExtension.Custom12 custom12
userExtension.Custom13 custom13
userExtension.Custom14 custom14
userExtension.Custom15 custom15
userExtension.Hr.UserId hr.userId
userExtension.Hr.Email hr.email
userExtension.Hr.Username hr.username
userExtension.Hr.Active hr.status
userExtension.Manager.UserId manager.userId
userExtension.Manager.Email manager.email
userExtension.Manager.Username manager.username
userExtension.Manager.Active manager.status
Table 39: Group mapping
SCIM parameter SuccessFactors parameter
Id groupID
displayName groupName

members.value

userId

members.display

userName

groupExtension.groupType groupType
groupExtension.staticGroup staticGroup
Meta.LastModified lastModifiedDate

Connector limitations

  • Create and Delete group operations are not supported due to cloud application limitations.
  • When the active status is updated to false while performing the PUT operation for a user, the following error appears: user not found. This error occurs because a user is considered as a deleted user when the active status is false. (applicable for version V1 to V3)

  • User update does not support addition and removal of Groups or Roles for a particular user. It is done using group update. This is not applicable for role update.

  • Due to the API limitation of the target system, only the groups with type "permission" and "ectworkflow" are supported by version 3.0 of the connector.

  • User employee number cannot be updated because the cloud application considers employee number as a user Id. (applicable from version V1 till V3)

  • The UPDATE of Static Group supports the change of name and memberships. However, the UPDATE of Dynamic Group supports only the change of name but not the memberships. This is due to the target system behavior.

  • The manager/hr attribute gets added under user only if manager/hr in the request has the status as active.

  • Non-existing users should not be assigned as manager/hr while creating/updating user.

The Disable attribute feature can be used when you want to skip an attribute that exists in the target system.

For the SuccessFactors connector, the attributes of the User object, including those of Enterprise User, can be disabled or enabled while configuring the connector based on your requirements.

NOTE:

  • Mandatory attributes cannot be disabled.
  • For more information about how to disable attributes in Starling Connect, see Disabling attributes in the Appendix section.

Connector versions and features

The following subsections describe the different connector version(s) and features available with them.

Features available exclusively in SuccessFactors v.1.0

Following are the features that are available exclusively in SuccessFactorsv.1.0:

  • Update of basic attributes on Static and Dynamic Groups are supported.

  • Update of Group membership on Static and Dynamic Groups are supported.

  • Update of Dynamic Groups will remove the associated Dynamic Clauses.

  • Supported insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.2.0

Following are the features that are available exclusively in SuccessFactors v.2.0:

  • Update of basic attributes on Dynamic Groups are supported.

  • Update of Group membership on Static Groups are supported.

  • Dynamic Group supports group basic attributes update, but not group memberships.

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Static Group Update (supports only Add and Remove operations for Group Members)
  • Dynamic Group Update (supports Group Update without removing the existing dynamic clauses)

    NOTE:

    • These features are available from version 2.0 onwards.
    • In version 1.0, only Dynamic Group Update is supported. Static Group Update is not supported in version 1.0.
    • Version 2.0 is enhanced to allow you to use the Dynamic Group Update operation to update the attributes of a Dynamic Group without removing the dynamic clause that you have added for that Dynamic Group.

      This feature is available from version 2.0 onwards. In version 1.0 of the connector, the Dynamic Group Update function removes the existing dynamic clause that was added for the Dynamic Group.

Features available exclusively in SuccessFactors v.3.0

Following are the features that are available exclusively in SuccessFactorsv.3.0:

  • Supports all the features from v2.0.

  • Synchronization has been improved by limiting the groups type to ‘Permission’ and ‘ectworkflow’.

  • Supports insert / update / upsert on inactive users using extended permissions.

Features available exclusively in SuccessFactors v.4.0

Following are the features that are available exclusively in SuccessFactorsv.4.0:

  • Supported insert / update / upsert on inactive users using extended permissions.

  • Additional attributes ( userId, jobCode, location, All available "CustomXX", hr(complex), manager(complex) ) supported under users.

  • Setting up a custom unique UserID on CREATE is supported.

  • DELETE operation not supported in Users endpoint.

  • Supported Custom Attributes for Users. Refer How to create custom attributes for users in Successfactors portal

Features available exclusively in SuccessFactors v.5.0

Following are the features that are available exclusively in SuccessFactorsv.5.0:

  • v.5.0 has no feature change only addition is that it supports OAuth Authentication.
  • For detailed explanation on setting up OAuth Authentication, refer SetUp OAuth.

  • Supported an additional parameter apiOptionProfileID as a config field while Create/update users.

Support for filter condition

SuccessFactors connector supports filter condition for User objects. Filter condition can be applied, and the Users can be retrieved selectively. Based on the supported operators and values provided at the filter the User objects are returned in the response from the connector.

To configure changes to One Identity Manager to support filter conditions

  1. Open the Synchronization Editor tool.

  2. Select SCIM connector.

  3. Select the Target system and navigate to Schema Classes.

    For example - id ne '10056' AND (locale eq 'Cleveland (1000-2011)')

  4. Add a new schema class for the user.

  5. Add the System filter and Select Object condition.

    Click Commit to Database.

  6. In User mappings, create or edit the Target system schema class with the recently created schema and click Commit to Database.

  7. Run the synchronization.

  8. Filter conditions are created.

Supported attributes for filter

  • id
  • userName
  • lastModified
  • meta.lastModified
  • givenName
  • familyName
  • division
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.division
  • department
  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.department

NOTE:

  • The connector supports filter condition in all versions but only for User objects.

  • Supports only AND and OR logical operators.

  • Supports only parenthesis () for grouping the condition.

  • Unsupported attributes in the filter request will be ignored, no error will be thrown.

  • Only the sub-attributes of a complex attribute are supported in filter condition. For example, givenName or familyName

Table 40: Supported operators to filter values
S. No

Operators

OneIM System Filters

OneIM Select Objects

1

eq → equal to

lastModified eq 2020-08-27T15:22:52

lastModified = 2020-08-27T15:22:52

2

ne → not equal to

lastModified ne 2020-08-27T15:22:52

lastModified <> 2020-08-27T15:22:52

3

gt → greater than

lastModified gt 2020-08-27T15:22:52

lastModified > 2020-08-27T15:22:52

4

lt → less than

lastModified lt 2020-08-27T15:22:52

lastModified < 2020-08-27T15:22:52

5

ge → greater than or equal to

lastModified ge 2020-08-27T15:22:52

lastModified >= 2020-08-27T15:22:52

6

le → less than or equal to

lastModified le 2020-08-27T15:22:52

lastModified <= 2020-08-27T15:22:52

Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation