Chat now with support
Chat with Support

Active Roles Sync Service 8.2 - 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

Creating a Microsoft Azure Active Directory connector with automatic configuration

Synchronization Service reads and writes data in Microsoft Azure Active Directory by using an Azure application in your Microsoft Azure Active Directory environment. To create a connection to Microsoft Azure Active Directory, use the Microsoft Azure AD Connector of the Active Roles Synchronization Service.

You can create an Azure AD connector by configuring an Azure application automatically in the Synchronization Service Console. One Identity recommends using Auto configuration if you want to create a new Azure application for the connection.

To create a new Azure AD connector with automatic configuration

  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 Azure AD Connector.

  3. Click Next.

  4. To create a new Azure application or update an existing one, select Auto configuration.

    NOTE: If you have more than one Azure Active Directory (Azure AD) service in your Azure tenant, select I have more than one Azure AD in my Azure tenant, and use the Tenant ID field to specify the GUID of the Azure AD for which you want to set up synchronization. For more information, see Finding the GUID (Tenant ID) of an Azure AD for Azure BackSync.

  5. Select one of the following options based on the number of Azure AD services in your Azure tenant:

    • I have one Azure AD in my Azure tenant.

    • I have more than one Azure AD in my Azure tenant.

  6. Authenticate your access to Azure AD:

    • If you have selected I have one Azure AD in my Azure tenant, to authenticate your access to Azure AD, click Log in to Azure, and from the Select Environment Type drop-down, select the environment type of your Azure tenant.

      NOTE: Active Roles Synchronization Service supports Azure Cloud, Azure GCC and Azure GCC-H government tenants.

    • If you have selected I have more than one Azure AD in my Azure tenant, in Tenant ID, enter the GUID of the Azure AD for which you want to set up synchronization.

      TIP: For more information on how to find the GUID of an Azure AD service, see Finding the GUID (Tenant ID) of an Azure AD for Azure BackSync.

      After specifying the tenant ID, to authenticate your access to Azure AD, click Log in to Azure, and in the Select Environment Type drop-down, select the environment of your Azure tenant.

      NOTE: If you select I have more than one Azure AD in my Azure tenant, the Log in to Azure button will be enabled only if you specify a well-formed Azure AD GUID in the Tenant ID text box.

  7. Azure application name: Enter the name of the new or existing Azure application.

  8. To create or update the Azure application in Azure AD, click Create or update Azure application.

    The created or updated Azure application has the following directory roles assigned to it:

    • Directory Writers

    • Exchange Administrator

    • User Administrator

    The following permissions are also added, for which you must give admin consent:

    • Sign in and read user profile

    • Manage Exchange As Application

    NOTE: You may need to set additional permissions depending on your needs.

  9. To give admin consent for the permissions of the Azure application, click Consent. Then, in the Azure Tenant Consent dialog, click Accept.

  10. To test the connection with the new parameters, click Test connection.

  11. To finish creating a connection to Azure AD, click Finish.

Configuring an Azure application for a Microsoft Azure Active Directory connection using a script

Synchronization Service reads and writes data in Microsoft Azure Active Directory by using an Azure application in your Microsoft Azure Active Directory environment.

To create an Azure AD connection by configuring an Azure application using a Windows PowerShell script, perform the following steps.

To configure an Azure application for an Azure Active Directory connection using a Windows PowerShell script

  1. Create an application in any domain of your Microsoft Azure Active Directory environment. The application must have sufficient permissions to read and write data in Microsoft Azure Active Directory.

    You can assign the required permissions to the application by running a Windows PowerShell script. To run the script, you need to install Microsoft Azure PowerShell on your computer.

    Script example
    # Replace <ClientId> with the Client ID of the Active Roles Azure AD Connector Application (example format: 455ad643-332g-32h7-q004-8ba89ce65ae26)

$Id = “<ClientId>”

# Prompt for Microsoft Azure AD Global Admin credentials.

Connect-AzureAD

# Get the Principal ID of the Active Roles Azure AD Connector Application and save it to the $servicePrincipal variable

$servicePrincipal = Get-AzureADServicePrincipal -All $true | Where-Object {$_.AppId -eq $Id}

# Get the required role ID from the Active Roles Azure AD Connector Application and save it to the $roleId variable

$roleId = (Get-AzureADDirectoryRole | Where-Object {$_.displayName -eq 'Company Administrator'}).ObjectId

# Assign the required permissions to the Active Roles Azure AD Connector Application

Add-AzureADDirectoryRoleMember -ObjectId $roleId -RefObjectId $servicePrincipal.ObjectId

  2. Open the application properties and copy the following information:

    • Tenant ID

    • Application ID

    • Certificate thumbprint

  3. When creating a new Microsoft Azure Active Directory connection or modifying an existing one in the Synchronization Service Console, enter the Tenant ID, Application ID, and Certificate thumbprint of the Azure tenant as they appear on the Azure portal. For more information, see Creating a Microsoft Azure Active Directory connection.

Modifying a Microsoft Azure Active Directory connection

Synchronization Service reads and writes data in Microsoft Azure Active Directory by using an Azure application in your Microsoft Azure Active Directory environment. To create a connection to Microsoft Azure Active Directory, use the Microsoft Azure AD Connector of the Active Roles Synchronization Service.

You can modify the settings of an existing Azure AD connector in the Synchronization Service Console.

Modifying the manual configuration settings of a Microsoft Azure Active Directory connector

You can modify the manual configuration settings of an existing Azure AD connector in the Synchronization Service Console.

IMPORTANT: If you are upgrading from an older version of Active Roles Synchronization Service to Active Roles Synchronization Service 8.1.3 or later, and the connector was configured manually, then you must update the authentication data to be able to run a synchronization workflow.

To update the authentication data, you can:

To modify the manual configuration settings of a Azure AD connector

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

  2. Click Connection settings under the existing Azure AD connection you want to modify.

  3. On the Connection Settings tab, click Specify connection settings to expand it and use the following options.

  4. To use an existing Azure application, select Manual configuration.

    NOTE: Alternatively, to use and update an existing Azure application, you can also select Auto configuration. Under Auto configuration, click Log in to Azure, then select the Tenant environment type of the Azure tenant. After logging in to Azure with your tenant, the Tenant ID, Application ID, Certificate thumbprint and Tenant environment type parameters will be automatically filled in.

  5. Enter the Tenant ID, Application ID and Certificate thumbprint of the Azure tenant as they appear on the Azure portal. Then, select the Tenant Environment Type of the Azure tenant.

  6. To test the connection with the new parameters, click Test connection.

  7. To modify the connection settings, click Save.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating