Chat now with support
Chat mit Support

Active Roles 8.1.2 - 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 Database Working with Oracle Database user accounts 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 an OpenLDAP directory service Working with IBM DB2 Working with IBM AS/400 Working with IBM RACF Working with MySQL database Working with an OLE DB-compliant relational database Working with SharePoint Working with Microsoft 365 Working with Microsoft Azure Active Directory 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 Developing PowerShell scripts for attribute synchronization rules Using PowerShell script to transform passwords

Creating a SCIM connection with the SCIM Connector

You can configure an Active Roles Synchronization Service connection to the PingOne and Workday HR connectors of Starling Connect with the SCIM Connector.

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

  1. In the Synchronization Service Console, open the Connections tab.
  2. Click Add connection, then use the following options:
    • Connection name: Type a descriptive name for the connection.

    • Use the specified connector: Select SCIM Connector.

  3. Click Next.

  4. On the Specify connection settings page, under SCIM settings, configure the following connection options:

    • SCIM version: Select the SCIM protocol version to use for the connection. The SCIM Connector supports protocol versions V2 and V1.1.

    • SCIM URL: Specify the the base URL of the Starling Connect connector to which you want to connect.

    • Authentication type: Select the authentication type. The SCIM Connector supports Basic, OAuth and API Key-based authentication. The contents of the Authentication parameters section are populated dynamically based on the authentication type you select in this setting.

  5. Under Authentication parameters, configure the applicable options:

    • If you use Basic authentication, provide a valid User name and Password.

      NOTE: The PingOne connector of Starling uses the API key as the User name and the API token as the Password.

    • If you use OAuth authentication, configure the settings applicable to the selected Grant type.

      Table 104: SCIM Connector OAuth authentication settings

      Grant type

      Setting

      Description

      password

      Token URL

      		Specify the URL of the token.

      User name

      		Specify the user name.

      Password

      		Specify the password.

      Client ID

      		Specify the client ID used for login.

      Client secret

      		Specify the client secret.

      client_credentials

      Token URL

      		Specify the URL of the token.

      Client ID

      		Specify the client ID used for login.

      Client secret

      		Specify the client secret.

      Bearer_Token

      Bearer token

      Specify the bearer token for the connection.

      NOTE: Connections using a bearer token have a time-limit, specified by the token provider. Once this time limit is reached, the connection ends. To establish a new connection session, you must create a new bearer token.

    • If you use API Key authentication, specify the API Key and Token for the connection.

  6. (Optional) To connect to the Workday HR connector of Starling with the configured SCIM Connector, select Load workday schema. Selecting this option will result in the configured SCIM Connector using the Workday schema instead of the standard SCIM schema.

    NOTE: Select Load workday schema only if you want to connect to the Workday HR connector of Starling. Attempting to connect to the PingOne connector with this setting enabled will result in the SCIM Connector failing to synchronize data.

  7. (Optional) To configure additional authentication parameters (such as a region ID or organization ID) for the SCIM Connector, click Add additional parameters. Then, use the Additional authentication parameters settings to specify additional Plain text parameters or Masked parameters. To save the parameters, click OK.

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

  9. To create the connection, click Finish.

Viewing or modifying the settings of a SCIM Connector

You can view or modify an existing connection based on the SCIM Connector with Active Roles Synchronization Service. Modifying a SCIM Connector 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 SCIM Connector connection

  1. In the Synchronization Service Console, open the Connections tab.

  2. Click Connection settings below the existing SCIM connection you want to modify.

  3. On the Connection Settings tab, click the Specify connection settings item to expand it and update the required settings.

    For more information on the available settings, see Creating a SCIM connection with the SCIM Connector.

  4. To apply your changes, click Save.

Configuring data synchronization with the Generic SCIM Connector

With the Generic SCIM Connector, you can configure inbound data synchronization connections for a set of SCIM 2.0-based One Identity Starling Connect connectors:

NOTE: Consider the following when planning to configure a SCIM-based data synchronization connector:

  • The Generic SCIM Connector was tested with the following Starling Connect connectors:

    • Pipedrive 1.0

    • ServiceNow 2.0

    • SuccessFactors HR 8.0 and 9.0

    • WorkdayHR 3.0

    • Zendesk 1.0

    While the Generic SCIM Connector may work with other SCIM 2.0-based Starling Connect connectors, One Identity tested it to work only with those connectors and connector versions.

  • To configure a connection to the PingOne connector of Starling Connect, use the SCIM Connector of Active Roles Synchronization Service. For more information, see Configuring data synchronization with the SCIM Connector.

For the list of Active Roles Synchronization Service connector features that the Generic SCIM Connector supports or does not support, see the following table.

Table 105: Generic SCIM Connector – Supported features

Feature

Supported

Bidirectional synchronization

Specifies whether you can both read and write data in the connected data system.

No

Delta processing mode

Specifies whether the connection can process only the data that has changed in the connected data system since the last synchronization operation. This reduces the overall synchronization duration.

No

Password synchronization

Specifies whether you can synchronize user passwords from an Active Directory (AD) domain to the connected data system.

No

Secure Sockets Layer (SSL) data encryption

Specifies whether the connector can use SSL to encrypt data transmitted between Active Roles Synchronization Service and the connected data system.

Yes

For more information on the SCIM protocol, see the official SCIM site, or the following IETF RFC documents:

  • IETF RFC-7642: System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements

  • IETF RFC-7643: System for Cross-domain Identity Management: Core Schema

  • IETF RFC-7644: System for Cross-domain Identity Management: Protocol

Configuring the Generic SCIM Connector for Starling Connect connections

You can configure an Active Roles Synchronization Service connection to the following Starling Connect connectors with the Generic SCIM Connector:

  • Pipedrive 1.0

  • ServiceNow 2.0

  • SuccessFactors HR 8.0 and 9.0

  • WorkdayHR 3.0

  • Zendesk 1.0

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 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

  • You are aware of the specific implementation details (such as the supported objects and operations) of the Starling Connect connector you want to connect to. For more information, see the connector-specific sections of the Starling Connect Active Roles Administration Guide.

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

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

    Figure 4: 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 5: Add Connection – Specifying the connection name and connector type

  3. (Optional) If you want 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 6: 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, 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 - v2.0.

    NOTE: The Starling batch 1 - v2.0 implementation plugin is backwards compatible with Starling batch 1 - v1.0, originally released in Active Roles 7.6.1.

    The Generic SCIM Connector was tested with the following Starling Connect connectors:

    • Pipedrive 1.0

    • ServiceNow 2.0

    • SuccessFactors HR 8.0 and 9.0

    • WorkdayHR 3.0

    • Zendesk 1.0

    While the Generic SCIM Connector may work with other SCIM 2.0-based Starling Connect connectors, One Identity tested it to work only with those connectors and connector versions.

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

  8. Configure the following Starling Connect connection settings as required by the Starling Connect connector to which you want to connect.

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

      NOTE: Consider the following when using this setting:

      • Selecting this setting decreases synchronization speed considerably. However, you must select this setting to read all object attributes for Starling Connect ServiceNow 2.0, or to read certain resource types or attributes for Zendesk 1.0.

      • Do not enable this setting when configuring the Generic SCIM Connector for other supported Starling Connect connectors, as it has no effect on the results of import data synchronization.

    • Query only synced attributes: To improve performance, certain Starling Connect connectors allow to query only parameters that are specifically defined for synchronization. If you enable this setting, Synchronization Service sets the ?attributes=attrName query parameter according to IETF RFC-7644, so that Starling Connect will retrieve the attributes specified in the sync workflow.

      NOTE: Select this setting if you configure a connection for the Starling Connect Pipedrive 1.0 or Zendesk 1.0 connectors.

    • Starling cursor-based pagination: Certain Starling Connect connectors use a cursor-based pagination method (as defined by Cursor-based Pagination of SCIM Resources) instead of the protocol-defined index-based pagination. When configuring a connection to such a Starling Connector, select this setting to override the standard pagination method.

      NOTE: Select this setting if you configure a connection to the Starling Connect Pipedrive 1.0, WorkdayHR 3.0 or Zendesk 1.0 connectors.

    • Max degree of parallelism: If Import uses direct query is enabled, this setting specifies the maximum number of threads that Synchronization Service Console can run in parallel for the direct query of each object in the response list (that is, how many entries can Synchronization Service Console 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-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.

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

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen