Chat now with support
Chat with Support

Active Roles 8.0 LTS - Synchronization Service Administration Guide

Synchronization Service Overview Deploying Synchronization Service Getting started Connections to external data systems
External data systems supported with built-in connectors
Working with Active Directory Working with an AD LDS (ADAM) instance Working with Skype for Business Server Working with Oracle Working with Exchange Server Working with Active Roles Working with One Identity Manager Working with a delimited text file Working with Microsoft SQL Server Working with Micro Focus NetIQ Directory Working with Salesforce Working with ServiceNow Working with Oracle Unified Directory Working with an LDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with an OpenLDAP directory service Working with IBM RACF connector Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Configuring data synchronization with the Office 365 Connector
Creating a Microsoft 365 connection Viewing or modifying a Microsoft 365 connection Microsoft 365 data supported for data synchronization
ClientPolicy object attributes supported for Microsoft 365 data synchronization ConferencingPolicy object attributes supported for Microsoft 365 data synchronization Contact object attributes supported for Microsoft 365 data synchronization DistributionGroup object attributes supported for Microsoft 365 data synchronization Domain object attributes supported for Microsoft 365 data synchronization DynamicDistributionGroup object attributes supported for Microsoft 365 data synchronization ExternalAccessPolicy object attributes supported for Microsoft 365 data synchronization HostedVoicemailPolicy object attributes supported for Microsoft 365 data synchronization LicensePlanService object attributes supported for Microsoft 365 data synchronization Mailbox object attributes supported for Microsoft 365 data synchronization MailUser object attributes supported for Microsoft 365 data synchronization PresencePolicy object attributes supported for Microsoft 365 data synchronization SecurityGroup object attributes supported for Microsoft 365 data synchronization SPOSite object attributes supported for Microsoft 365 data synchronization SPOSiteGroup object attributes supported for Microsoft 365 data synchronization SPOWebTemplate object attributes supported for Microsoft 365 data synchronization SPOTenant object attributes supported for Microsoft 365 data synchronization User object attributes supported for Microsoft 365 data synchronization VoicePolicy object attributes supported for Microsoft 365 data synchronization Microsoft 365 Group attributes supported for Microsoft 365 data synchronization Changing the display names of synchronized Microsoft 365 licenses and services
Objects and attributes specific to Microsoft 365 services How the Office 365 Connector works with data
Configuring data synchronization with the Microsoft Azure AD Connector Configuring data synchronization with the SCIM Connector Configuring data synchronization with the Generic SCIM Connector
Using connectors installed remotely Creating a connection Renaming a connection Deleting a connection Modifying synchronization scope for a connection Using connection handlers Specifying password synchronization settings for a connection
Synchronizing identity data Mapping objects Automated password synchronization Synchronization history Scenarios of use
About scenarios Scenario 1: Create users from a .csv file to an Active Directory domain Scenario 2: Use a .csv file to update user accounts in an Active Directory domain Scenario 3: Synchronizing data between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 4: Deprovisioning between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 5: Provisioning of Groups between One Identity Manager Custom Target Systems and an Active Directory domain Scenario 6: Enabling Delta Sync mode between One Identity Manager Custom Target Systems and an Active Directory domain Example of using the Generic SCIM Connector for data synchronization
Appendix A: Developing PowerShell scripts for attribute synchronization rules Appendix B: Using a PowerShell script to transform passwords

Configuring the Generic SCIM Connector for Starling Connect connections

You can configure an Active Roles Synchronization Service connection to the SuccessFactors HR 8.0 and ServiceNow 2.0 connectors of Starling Connect with the Generic SCIM Connector.

Prerequisites

Before configuring the connection, make sure that the following conditions are met:

  • Your organization must have an active Starling Connect account.

  • The Starling connector to which you want to connect (SuccessFactors HR 8.0 or ServiceNow 2.0) must be already configured in Starling Connect.

  • If your organization is using a proxy server for outbound connections, make sure that the system level proxy settings are properly configured.

    To configure system-level proxy settings, navigate to one of the following Windows configuration pages:

    • Control Panel > Internet Settings > Connections > LAN Settings

    • Settings > Network and Internet > Proxy

To configure a connection to a Starling Connect connector with the Generic SCIM Connector

  1. In the Active Roles Synchronization Service Console, navigate to Connections > Add Connection.

    Figure 6: Active Roles Synchronization Service Console – Adding a new connection via Connections > Add connection

  2. In the Name connection and select connector step, specify a custom Connection name. Then, to load the SCIM-specific connector settings, from the Use the specified connector drop-down list, select Generic: SCIM Connector.

    Figure 7: Add Connection – Specifying the connection name and connector type

  3. (Optional) If you plan to use a remote connector for the configured connection, configure Remote connector access as described in Creating a connection using a remotely installed connector. To continue, click Next.

  4. To continue, click Next.

    The Connection settings step of the Generic SCIM Connector appears.

    Figure 8: Generic SCIM Connector – General, authentication and implementation settings

  5. Under General settings, specify the base SCIM URL of the Starling Connect connector to which you want to connect.

    TIP: To check the base SCIM URL of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, select the SCIM-based connector to which you want to connect (SuccessFactors HR or ServiceNow), then copy the value of the SCIM URL property.

  6. Under Authentication settings, to enable the authentication scheme options required by the supported Starling Connect connectors, select the Starling authentication scheme, then configure the following settings:

    • Token endpoint URL: Specifies the full path of the Starling connector token endpoint.

      TIP: To find the token endpoint URL of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the SCIM Token Endpoint URL property.

    • Client ID: Specifies the SCIM client ID.

      TIP: To find the SCIM client ID of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the SCIM Client ID property.

    • Client secret: Specifies the SCIM client secret.

      TIP: To find the SCIM client secret of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the Show SCIM Client Secret text box.

  7. Under Implementation plugin, to enable the pre-made connection implementation for the supported Starling Connect connectors, select Starling batch 1 - v1.0.

    NOTE: While the Generic SCIM Connector may work with other SCIM 2.0-based Starling Connect connectors whose attribute query semantics are compatible on a network level with the SuccessFactors HR 8.0 and ServiceNow 2.0 connectors, One Identity tested it to work only with these two connectors.

    For the list of SCIM attributes supported by Starling Connect for these connectors, see the SuccessFactors and ServiceNow chapters of the Starling Connect Active Roles Administration Guide.

  8. (Optional) Configure the following Starling Connect connection settings:

    • Import uses direct query: When selected, Active Roles Synchronization Service queries every synchronized object separately by their ID. One Identity recommends selecting this setting when configuring a connection to the Starling Connect ServiceNow 2.0 connector, or similar connectors.

      NOTE: Enabling this setting decreases synchronization speed considerably, but it is required to read all object attributes for Starling Connect ServiceNow 2.0 (or similar) connectors.

      However, do not enable this setting when configuring the Generic SCIM Connector for the Starling Connect SuccessFactors HR connector, as it has no effect on the results of import data synchronization.

    • Max degree of parallelism: If Import uses direct query is enabled, this setting specifies the maximum number of threads that Active Roles Synchronization Service can run in parallel for the direct query of each object in the response list (that is, how many entries can Active Roles Synchronization Service query simultaneously).

      TIP: One Identity recommends testing the value optimal for your environment, and setting it as low as possible. Specifying a value of 1 means no parallelism is configured.

      NOTE: Consider the following when using this setting:

      • This setting works only if Import uses direct query is enabled. Active Roles Synchronization Service will ignore any value specified for Max degree of parallelism if Import uses direct query is not selected.

      • Setting the value of Max degree of parallelism too high may result in connector service instability.

  9. Check the implementation plugin information indicated on the screen. Make sure that the Supported Features, the Target Service Providers and the supported Starling Connect connector versions will meet the requirements of your planned mapping rule and/or synchronization workflow.

  10. To verify that the specified authentication settings are correct, click Test Connection.

    NOTE: Clicking Test Connection verifies only if the authentication settings for the SCIM metadata endpoint connection are correct, and if Active Roles Synchronization Service can fetch the SCIM schemas and query the resourceTypes metadata from the configured SCIM service.

    When testing the connection, Active Roles Synchronization Service does not query any actual resource objects. Because of this, testing may finish successfully even if the connection is down between Starling Connect and the third-party service provider (for example, SuccessFactors HR), preventing the import of actual data during synchronization later.

    TIP: If testing fails, Active Roles Synchronization Service will highlight the settings that it detects as incorrect. Check and fix those settings, then try again. If testing fails again, then:

    • Check your network connectivity.

    • Check if the Starling Connect service is available.

    • Make sure that the Starling Connect connector you specified during configuration is still active and working.

    • If you use a proxy server, make sure that the system-level proxy settings are properly configured.

  11. If testing completed successfully, create the new SCIM connection to the Starling Connect connector by clicking Finish.

Once Active Roles Synchronization Service creates the connection, you can use it to configure SCIM-based data synchronization by setting up one or more mapping rules and synchronization workflows.

Viewing or modifying the settings of a Generic SCIM Connector connection

You can view or modify an existing connection based on the Generic SCIM Connector with the Active Roles Synchronization Service Console. Modifying a Generic SCIM Connector connection is typically required if any change occurs in the SCIM-based Starling Connect connectors to which the Active Roles Synchronization Service connection was originally configured.

To view or modify an existing Generic SCIM Connector connection

  1. In the Active Roles Synchronization Service Console, click Connections.

  2. In the Connections page, search for the connection you want to modify, then click Connection settings.

  3. (Optional) In General, modify the custom Connection name.

  4. (Optional) In Connection Settings, modify the following settings as you need:

    • Token endpoint URL: Specifies the full path of the Starling connector token endpoint.

      TIP: To find the token endpoint URL of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the SCIM Token Endpoint URL property.

    • Client ID: Specifies the SCIM client ID.

      TIP: To find the SCIM client ID of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the SCIM Client ID property.

    • Client secret: Specifies the SCIM client secret.

      TIP: To find the SCIM client secret of the Starling Connect connector, in Starling Connect, navigate to Connectors > Active Connectors, and copy the value of the Show SCIM Client Secret text box.

    • Import uses direct query: When selected, Active Roles Synchronization Service queries every synchronized object separately by their ID. One Identity recommends selecting this setting when configuring a connection to the Starling Connect ServiceNow 2.0 connector, or similar connectors.

      NOTE: Enabling this setting decreases synchronization speed considerably, but it is required to read all object attributes for Starling Connect ServiceNow 2.0 (or similar) connectors.

      However, do not enable this setting when configuring the Generic SCIM Connector for the Starling Connect SuccessFactors HR connector, as it has no effect on the results of import data synchronization.

    • Max degree of parallelism: If Import uses direct query is enabled, this setting specifies the maximum number of threads that Active Roles Synchronization Service can run in parallel for the direct query of each object in the response list (that is, how many entries can Active Roles Synchronization Service query simultaneously).

      TIP: One Identity recommends testing the value optimal for your environment, and setting it as low as possible. Specifying a value of 1 means no parallelism is configured.

      NOTE: Consider the following when using this setting:

      • This setting works only if Import uses direct query is enabled. Active Roles Synchronization Service will ignore any value specified for Max degree of parallelism if Import uses direct query is not selected.

      • Setting the value of Max degree of parallelism too high may result in connector service instability.

  5. (Optional) In Scope, modify the scope of objects included in the data synchronization process of the connection. For more information on the Scope settings, see Modifying synchronization scope for a connection.

  6. (Optional) In Connection Handlers, create, update or remove any automated data synchronization operations for the connection. For more information on the Connection Handlers settings, see Using connection handlers.

  7. To apply your changes, click Save and Continue.

Using connectors installed remotely

In some cases, you need to configure a connection to an external data system which is separated by a firewall from the computer running Synchronization Service. To implement this scenario, you can install an instance of Synchronization Service and built-in connectors on a remote computer and switch this Synchronization Service instance in the remote mode. This will allow the Synchronization Service instance running in the local mode to communicate with the remotely installed instance and connectors via a single port.

Consider a scenario where you want to synchronize data between two Active Directory domains that are separated by a firewall. In this case, you can install one Synchronization Service instance in the local mode in the first domain, and then deploy another Synchronization Service instance in the remote mode in the other domain. Then, ensure the firewall allows traffic on the port used for communications between the Synchronization Service instances.

In this section:

Steps to install Synchronization Service and built-in connectors remotely

Steps to install Synchronization Service and built-in connectors remotely

To use connectors remotely, you need to install Synchronization Service and built-in connectors on a required remote computer and switch the installed instance of Synchronization Service to remote mode. For installation instructions, see Step 1: Install Synchronization Service.

To set Synchronization Service in remote mode

  1. Start the Synchronization Service Administration Console.
  2. Follow the steps in the wizard that starts automatically to configure Synchronization Service.
  3. On the Service Account and Mode page, do the following and click Finish:
    • Enter the account under which you want Synchronization Service to run.
    • Select the remote mode for this instance of Synchronization Service.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating