Chat now with support
Chat with Support

Identity Manager 8.0 - Administration Guide for Connecting to Exchange Online

Managing Exchange Online Environments Setting up Exchange Online Synchronization Base Data for Managing Exchange Online Appendix: Configuration Parameters for Managing Exchange Online Appendix: Default Project Template for Exchange Online Appendix: Editing System Objects

Users and Permissions for Synchronizing with Exchange Online

Users and Permissions for Synchronizing with Exchange Online

The following users are involved in synchronizing One Identity Manager with Exchange Online.

Table 2: Users for Synchronization
User Permissions
User for accessing Exchange Online You must provide a user account with the following permissions for full synchronization of Exchange Online objects with the supplied One Identity Manager default configuration.
  • Member in the role group "Organization Management
  • Member in the role group "Recipient Management"

NOTE: Make sure, to keep track of the password expiration interval of the synchronization user account. Expired passwords will cause synchronization issues.

You can disable the password expiration for the user account in One Identity Manager. For more information, see the One Identity Manager Administration Guide for Connecting to Azure Active Directory.

One Identity Manager Service user account

The user account for the One Identity Manager Service requires access rights to carry out operations at file level (issuing user rights, adding directories and files to be edited).

The user account must belong to the group "Domain Users".

The user account must have the extended access right "Log on as a service".

The user account requires access rights to the internal web service.

NOTE: If the One Identity Manager Service runs under the network service (NT Authority\NetworkService), you can issue access rights for the internal web service with the following command line call:

netsh http add urlacl url=http://<IP address>:<port number>/ user="NT AUTHORITY\NETWORKSERVICE"

The user account needs full access to the One Identity Manager Service installation directory in order to automatically update the One Identity Manager.

In the default installation the One Identity Manager is installed under:

  • %ProgramFiles(x86)%\One Identity (on 32-bit operating systems)
  • %ProgramFiles%\One Identity (on 64-bit operating systems)
User for accessing the One Identity Manager database

The default system user "SynchronizationClosed" is available to run synchronization over an application server.

Necessary Access Rights Explained

The user account for synchronization should be a member of the following roles:

  • Organization management
    Administrators who are members of the Organization Management role group have administrative access to the entire Exchange Online organization and can perform almost any task against any Exchange Online object. However, some exceptions apply (such as role Discovery Management).
  • Recipient Management
    Administrators who are members of the Recipient Management role group have administrative access to create or modify Exchange Online recipients within the Exchange Online organization.

There are two ways that you can assign these roles.

To assign permission through the Microsoft Online Portal

NOTE: This method requires assigning an Office 365 license to the user account for synchronization.
  1. Navigate to https://portal.microsoftonline.com and log in as administrator.
    This takes you to the Office 365 welcome page.
  2. Click the Administrator tile to open the Admin Center portal.
  3. Select Admin Center | Exchange from the menu on the left.
    This takes you to the Exchange Admin Center.
  4. Click Permissions in the menu on the left.
  5. Select the Recipient Management role and click the edit icon in the toolbar.
  6. Add the user account for synchronization to the Members list.
  7. Repeat steps 5 and 6 for the role Organization Management.

NOTE: If the synchronization user account does not appear in the list of members, you can allocate the permissions through Windows PowerShell as described below. It is most likely that the user account does not have a mailbox or is not assigned an Office 365 license. In this case, use the next method.

To assigned permissions through Windows PowerShell

  1. Run Windows PowerShell with administrator credentials from the context menu Run as Administrator.
  2. Enter this command at the prompt:

    $session = New-PSSession -Configurationname Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential (Get-Credential) -Authentication Basic –AllowRedirection

    $session = Import-PSSession

    This command finds the access data required for creating the connection and then connects to Exchange Online.

  3. Test the connection with the following command:

    Get-OrganizationConfig | fl *displayname*

    This displays the name of the organization.

  4. Enter the following command to add the roles for the synchronization user account:

    Add-RoleGroupMember -Identity "Organization Management" -Member "<user name of the synchronization user>"

    Add-RoleGroupMember -Identity "Recipient Management" -Member "<user name of the synchronization user>"

  5. Close the Exchange Online connection with:

    Get-PSSession | Remove-PSSession

Setting Up the Synchronization Server

To setup synchronization with an Exchange Online environment a server has to be available that has the following software installed on it:

  • Windows operating system

    Following versions are supported:

    • Windows operating system version 8.1. or later
    • Windows Server 2012
    • Windows Server 2012 R2
    • Windows Server 2016
  • Microsoft .NET Framework Version 4.5.2 or later

    NOTE: Microsoft .NET Framework version 4.6 is not supported.

    NOTE: Take the target system manufacturer's recommendations into account.
  • Windows Management Framework 4.0

  • One Identity Manager Service, Exchange Online connector
    • Install One Identity Manager components with the installation wizard.
      1. Select the option Select installation modules with existing database.
      2. Select the machine role Server | Job serverClosed | Exchange Online.

IMPORTANT: The One Identity Manager Exchange Online connector uses Windows PowerShell to communicate with the Microsoft Exchange server. For communication, extra configuration is required on the synchronization server and in Exchange Online. For more information, see Configuring Participating Servers for Remote Access through Windows PowerShell.

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Entries which are necessary for synchronization and administration with the One Identity Manager database are processed by the synchronization server. The synchronization server must be declared as a Job server in One Identity Manager.

NOTE: If several target system environments of the same type are synchronized under the same synchronization server, it is useful to set up a job server for each target system on performance grounds. This avoids unnecessary swapping of connection to target systems because a job server only has to process tasks of the same type (re-use of existing connections).

Use the Server Installer to install the One Identity Manager Service. This program executes the following steps.

  • Setting up a Job server.
  • Specifying machine roles and server function for the Job server.
  • Remote installation of One Identity Manager Service components corresponding to the machine roles.
  • Configures the One Identity Manager Service.
  • Starts the One Identity Manager Service.

NOTE: The program executes remote installation of the One Identity Manager Service. Local installation of the service is not possible with this program. Remote installation is only supported within a domain or a trusted domain.

To install and configure the One Identity Manager Service remotely on a server

  1. Start the program Server Installer on your administrative workstation.
  2. Enter valid data for connecting to One Identity Manager on the Database connection page and click Next.
  3. Specify on which server you want to install the One Identity Manager Service on the Server properties page.
    1. Select a job server in the Server menu.

      - OR -

      Click Add to add a new job server.

    2. Enter the following data for the Job server.
      Table 3: Job Servers Properties
      Property Description
      Server Name of the Job servers.
      Queue

      Name of queue to handle the process steps. Each One Identity Manager Service within the network must have a unique queue identifier. The process steps are requested by the job queue using exactly this queue name. The queue identifier is entered in the One Identity Manager Service configuration file.

      Full server name

      Full name of the server in DNS syntax.

      Example:

      <name of server>.<fully qualified domain name>

      NOTE: Use the Advanced option to edit other Job server properties. You can use the Designer to change properties at a later date.
  4. Specify which job server roles to include in One Identity Manager on the Machine role page. Installation packages to be installed on the Job server are found depending on the selected machine role.

    Select at least the following roles:

    • Exchange Online
  5. Specify the server's functions in One Identity Manager on the Server functions page. One Identity Manager processes are handled depending on the server function.

    The server's functions depend on which machine roles you have selected. You can limit the server's functionality further here.

    Select the following server functions:

    • Exchange Online ConnectorWindows PowerShell
  6. Check the One Identity Manager Service configuration on the Service settings page.

    NOTE: The initial service configuration is already predefined. If further changes need to be made to the configuration, you can do this later with the Designer. For more detailed information about configuring the service, see One Identity Manager Configuration Guide.
  7. To configure remote installations, click Next.
  8. Confirm the security prompt with Yes.
  9. Select the directory with the install files on the Select installation source page.
  10. Select the file with the private key on the page Select private key file.

    NOTE: This page is only displayed when the database is encrypted.
  11. Enter the service's installation data on the Service access page.
    Table 4: Installation Data
    Data Description
    Computer Server on which to install and start the service from.

    To select a server

    • Enter the server name.

      - OR -

    • Select a entry from the list.
    Service account One Identity Manager Service user account data.

    To enter a user account for the One Identity Manager Service

    • Set the option Local system account.

      This starts the One Identity Manager Service under the account "NT AUTHORITY\SYSTEM".

      - OR -

    • Enter user account, password and password confirmation.
    Installation account Data for the administrative user account to install the service.

    To enter an administrative user account for installation

      Enable Advanced
    • .
    • Enable the option Current user.

      This uses the user account of the current user.

      - OR -

    • Enter user account, password and password confirmation.
  12. Click Next to start installing the service.

    Installation of the service occurs automatically and may take some time.

  13. Click Finish on the last page of the Server Installer.

    NOTE: The is entered with the name "One Identity Manager Service" in the server's service administration.
Related Topics

Configuring Participating Servers for Remote Access through Windows PowerShell

Configuring Participating Servers for Remote Access through Windows PowerShell

NOTE: Run the configuration steps on the synchronization server.

To configure a server for remote access using Windows PowerShell

  1. Run Windows PowerShell with administrator credentials from the context menu Run as Administrator.
  2. Enter this command at the prompt:

    winrm quickconfig

    This command prepares for remote access usage.

  3. Enter this command at the prompt:

    Set-ExecutionPolicy RemoteSigned

    This command allows you to execute all Windows PowerShell commands (Cmdlets). The script must be signed by a trusted publishers.

To test remote access through Windows PowerShell from the synchronization server to the Microsoft Office 365.

  1. Run Windows PowerShell on the synchronization server.
  2. Enter this command at the prompt:

    $creds = New-Object System.Management.Automation.PsCredential -ArgumentList "<user>@<domain name>.onmicrosoft.com",(ConvertTo-SecureString "<password>" -AsPlainText -force)

    - OR -

    $creds = Get-Credential

    This command finds the access data required for making the connection.

  3. Enter this command at the prompt:

    $session = New-PSSession -Configurationname Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $creds -Authentication Basic –AllowRedirection

    This commands creates a remote session.

    NOTE: One Identity Manager connects to Outlook.

  4. Enter this command at the prompt:

    Import-PsSession $session

    This command imports the remote session so that the connection can be accessed.

  5. Test the functionality with any Microsoft Office 365 command. For example, enter the following command at the prompt:

    Get-Mailbox

Creating a Synchronization Project for initial Synchronization of an Exchange Online Environment

Creating a Synchronization Project for initial Synchronization of an Exchange Online Environment

Use the Synchronization EditorClosed to configure synchronization between the One Identity Manager database and Exchange Online. The following describes the steps for initial configuration of a synchronization project.

NOTE: Refer to the recommendations for setting up synchronization described in Exchange Online Synchronization Features.

IMPORTANT: Each Exchange Online environment should have its own synchronization project.

After the initial configuration, you can customize and configure workflows within the synchronization project. Use the workflow wizard in the SynchronizationClosed Editor for this. The Synchronization Editor also provides different configuration options for a synchronization project.

IMPORTANT: It must be possible to reach Exchange Online servers by DNS query for successful authentication. If the DNS cannot be resolved, the target system connection is refused.

Prerequisites for Setting Up a Synchronization Project
  • Synchronization of the Azure Active Directory system is carried out regularly.
  • The Azure Active Directory tenant is declared in One Identity Manager.

Have the following information available for setting up a synchronization project.

Table 5: Information Required for Setting up a Synchronization Project
Data Explanation

User account and password for logging in

User account and password for logging in to Exchange Online.

Example:

<user>@<domain.com>
<user name of the synchronization user>@yourorganisation.onmicrosoft.com

Make a user account available with sufficient permissions. For more information, see Users and Permissions for Synchronizing with Exchange Online.

Synchronization serverClosed for Exchange Online

The One Identity Manager Service with the Exchange Online connector must be installed on the synchronization server.

Table 6: Additional Properties for the Job Server
Property Value
Server Function Exchange Online connector
Machine role Server/Jobserver/Azure Active Directory/ExchangeOnline

For more information, see Setting Up the Synchronization Server.

One Identity Manager Database ConnectionClosed Data

SQL Server:

  • Database server
  • Database
  • Database user and password
  • Specifies whether Windows authentication is used.

    This type of authentication is not recommended. If you decide to use it anyway, ensure that your environment supports Windows authentication.

Oracle:

  • Species whether access is direct or through the Oracle client

    Which connection data is required, depends on how this option is set.

  • Database server
  • Oracle instance port
  • Service name
  • Oracle database user and password
  • Data source (TNS alias name from TNSNames.ora)
Remote connection serverClosed

To configure synchronization with a target system, One Identity Manager must load the data from the target system. One Identity Manager communicates directly with target system to do this. If you do not have direct access on the workstation on which the Synchronization Editor is installed, because of the firewall configuration, for example, you can set up a remote connection.

The remote connection server and the workstation must be in the same Active Directory domain.

Remote connection server configuration:

  • One Identity Manager Service is started
  • RemoteConnectPlugin is installed
  • Exchange Online connector is installed

The remote connection server must be declared as a Job server in One Identity Manager. The Job server name is required.

TIP: The remote connection server requires the same configuration (with respect to the installed software) as the synchronization server. Use the synchronization as remote connection server at the same time, by simply installing the RemoteConnectPlugin as well.

For more detailed information about setting up a remote connection, see the One Identity Manager Target System Synchronization Reference Guide.

NOTE: The following sequence describes how you configure a synchronization project if the Synchronization Editor is both:
  • In default mode
  • Started from the launchpad

Additional settings can be made if the project wizard is run in expert mode or is started directly from the Synchronization Editor. Follow the project wizard instructions through these steps.

To set up initial synchronization project for Exchange Online

  1. Start the Launchpad and log on to the One Identity Manager database.

    NOTE: If synchronization is executed by an application server, connect the database through the application server.
  2. Select the entry Exchange Online target system type. Click Run.

    This starts the Synchronization Editor's project wizard.

  1. Specify how the One Identity Manager can access the target system on the System access page.
    • If you have access from the workstation from which you started the Synchronization Editor, do not set anything.
    • If you do not have access from the workstation from which you started the Synchronization Editor, you can set up a remote connection.

      In this case, set the option Connect using remote connection server and select, under Job server, the server you want to use for the connection.

  1. Enter login data on the Connection parameters page for connecting to Exchange Online.
    Table 7: Connection parameters to Exchange Online
    Property Description
    User name (user@domain)

    Fully qualified name (FQDN) of the user account for logging in.

    Example:

    <user>@<domain.com>
    sync.user@yourorganisation.onmicrosoft.com

    Password Password for the user account.

    User Add set to enter more connection parameters. This allows you to add more synchronization users. These are queried cyclically by the Exchange Online connector when queries are sent to Exchange Online. By using multiple synchronization users, it takes longer to reach the throttling limit.

    For more detailed information about throttling limits in Exchange Online, see the Exchange Online documentation from Microsoft.

    To test the connection parameters separately, click in the set. Click Check all sets to test all sets at the same time.

    Click Next.

  2. Then click Finished to return to the project wizard.
  3. The wizard loads the target system schema. This may take a few minutes depending on the type of target system access and the size of the target system.
  1. Specify how system access should work on the page Restrict target system access. You have the following options:
    Table 8: Specifying Target System Access
    Option Meaning

    Read-only access to target system.

    Specifies whether a synchronization workflow should be set up to initially load the target system into the One Identity Manager database.

    The synchronization workflow has the following characteristics:

    • Synchronization is in the direction of "One Identity Manager".
    • Processing methods in the synchronization steps are only defined in synchronization direction "One Identity Manager".

    Changes are also made to the target system.

    Specifies whether a provisioning workflow should be set up in addition to the synchronization workflow to initially load the target system.

    The provisioning workflow displays the following characteristics:

    • Synchronization in the direction of the "target system"
    • Processing methods are only defined in the synchronization steps in synchronization direction "target system".
    • Synchronization steps are only created for such schema classes whose schema types have write access.
  2. Select the synchronization server to execute synchronization on the Synchronization server page.

    If the synchronization server is not declare as a job server in the One Identity Manager database yet, you can add a new job server.

    • Click to add a new job server.
    • Enter a name for the job server and the full server name conforming to DNS syntax.
    • Click OK.

      The synchronization server is declared as job server for the target system in the One Identity Manager database.

      NOTE: Ensure that this server is set up as the synchronization server after saving the synchronization project.
  1. Click Finish to complete the project wizard.

    This creates and allocates a default schedule for regular synchronization. Enable the schedule for regular synchronization.

    The synchronization project is created, saved and enabled immediately.

    NOTE: If the synchronization project is not going to be executed immediately, disable the option Activate and save the new synchronization project automatically.

    In this case, save the synchronization project manually before closing the Synchronization Editor.

    NOTE: The target system connection data is saved in a variable set, which you can change in the Synchronization Editor under Configuration | Variables if necessary.

To configure the content of the synchronization log

  1. To configure the synchronization log for target system connection, select the category Configuration | Target system.
  2. To configure the synchronization log for the database connection, select the category Configuration | One Identity Manager connection.
  3. Select General view and click Configure....
  4. Select the Synchronization log view and set Create synchronization log.
  5. Enable the data to be logged.

    NOTE: Certain content create a lot of log data.

    The synchronization log should only contain the data necessary for error analysis and other evaluations.

  6. Click OK.

To synchronize on a regular basis

  1. Select the category Configuration | Start up configurations.
  2. Select a start up configuration in the document view and click Edit schedule....
  3. Edit the schedule properties.
  4. To enable the schedule, click Activate.
  5. Click OK.

To start initial synchronization manually

  1. Select the category Configuration | Start up configurations.
  2. Select a start up configuration in the document view and click Execute.
  3. Confirm the security prompt with Yes.
Related Topics
Related Documents