Chat now with support
Chat with Support

Active Roles 8.1.3 - Synchronization Service Administration Guide

Synchronization Service overview Deploying Synchronization Service Deploying Synchronization Service for use with AWS Managed Microsoft AD 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

Deleting a connection

To delete a connection

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

  2. Locate the connection you want to delete, and then click Delete connection for that connection.

  3. When prompted, confirm that you want to delete the connection.

Modifying synchronization scope for a connection

For each connected data system, you can modify the scope of objects participating in the data synchronization operations.

To modify the synchronization scope

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

  2. Locate the connection for which you want to modify the synchronization scope, then click Synchronization scope.

  3. Use the following options to modify the synchronization scope:

    • Include objects from selected containers only: Select the check boxes next to the containers that hold the objects you want to participate in data synchronization operations.

      NOTE: This option may be unavailable for some types of connected data systems, such as Microsoft SQL Server or Oracle Database.

    • Objects must meet these conditions: Set up a list of conditions that objects must meet in order to participate in data synchronization operations.

  4. When you are finished, click Save.

Using connection handlers

Connection handlers allow you to automatically perform specific actions on connected data systems before, after, or instead of specific data synchronization operations (such as create, modify, move, rename, delete, or password synchronization). When creating a connection handler, you can specify the action you want to perform and set the conditions for triggering the action.

By default, Synchronization Service includes only one built-in handler type that can run your custom PowerShell script to perform the action you want. However, you can also implement your own custom handler types.

IMPORTANT: If the predefined connection handler is configured to run your PowerShell script instead of a data synchronization operation, the script must return a system entry object.

To create, modify, or delete handlers for a connection, use the Connection Handlers tab in the connection settings:

Figure 7: Connection Handlers

This tab provides the following elements:

  • Add handler: Starts a wizard that helps you add a new connection handler. By default, the wizard creates a new handler that allows you to run your PowerShell script.

  • Disable: Disables the connection handler.

  • Enable: Enables the connection handler.

  • Move up: Moves the connection handler one position up in the list.

  • Move down: Moves the connection handler one position down in the list.

  • Delete: Deletes the connection handler.

To create a connection handler

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

  2. Click the name of the connection for which you want to create a handler, then click the Connection Handlers tab.

  3. Click Add handler, then follow the steps in the wizard to create your handler.

To modify a connection handler

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

  2. Click the name of the connection for which you want to modify a handler, then click the Connection Handlers tab.

  3. Click the name of the handler you want to modify, then modify the handler settings as necessary. When you are finished, click OK.

  4. You can also do the following:

    • Change the order in which handlers are activated: Synchronization Service activates handlers in the order in which they appear in the list. To move a handler in the list, use the Move up and Move down links below the handler.

    • Disable or enable handlers: You can enable or disable existing handlers. To do so, use the Enable or Disable link below the handler.

  5. When you are finished, click Save.

To delete a connection handler

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

  2. Click the name of the connection for which you want to delete a handler, then click the Connection Handlers tab.

  3. Click Delete below the handler you want to delete.

Specifying password synchronization settings for a connection

For each connected data system that supports password synchronization, you can set password synchronization settings. These settings allow you to enable or disable password synchronization and manage passwords in the data system by using One Identity Password Manager.

Optionally, you can use the password synchronization settings to specify a custom Windows PowerShell script you want to run each time the password synchronization completes for the connected data system.

To specify password synchronization settings

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

  2. Click the name of the connection for which you want to modify password synchronization settings.

  3. Open the Password tab, and use the following options to modify the password synchronization settings as necessary:

    • Synchronize and manage passwords: Allows you to enable or disable password synchronization for this connection. Selecting this check box also allows you to manage passwords in the connected data system by using One Identity Password Manager. For more information on Password Manager, see https://www.oneidentity.com/products/password-manager/.

    • Synchronize passwords for objects of this type: Allows you to specify an object type that will participate in password synchronization. Click Select next to this text box, then specify the object type you want.

      NOTE: This option is only available for certain types of connected systems, such as the LDAP directory service.

    • Password synchronization method: Allows you to select a password synchronization method.

      NOTE: This option is only available for certain types of connected systems, such as LDAP directory service.

      You can select one of the following methods:

      • Write password to this attribute: Displays the object attribute in which the object password will be stored. To specify a different attribute, click Select next to the text box in this option.

      • Use LDAP extended operation: Allows you to automate the synchronization of user passwords in the connected data system regardless of the form of the authentication identity or the password storage mechanism used (for example, in the case of non-directory storage of passwords).

      • Configure Query: Allows you to use an SQL query to specify the data you want to participate in the password synchronization. Click Configure, then type your SQL query.

        NOTE: This option is only available for certain types of connected systems, such as LDAP directory service or Oracle Database.

  4. When you are finished, click Save.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating