Identity Manager 8.1 - Administration Guide for Connecting to SharePoint

Managing SharePoint Environments Setting Up SharePoint Farm Synchronization Basic data for managing a SharePoint environment SharePoint Farms SharePoint Web Applications SharePointSite Collections and Sites SharePoint User accounts SharePoint Roles and Groups
SharePoint Groups SharePoint Roles and Permission Levels
Permissions for SharePoint Web Applications Reports about SharePoint Site Collections Appendix: Configuration parameters for managing a SharePoint environment Appendix: Default Project Template for SharePoint

Setting Up SharePoint Farm Synchronization

To initially load SharePoint objects into the One Identity Manager database

  1. Prepare a user account with sufficient permissions for synchronizing in SharePoint.
  2. One Identity Manager parts for managing SharePoint systems are available if "TargetSystem\SharePoint" is set.

    Check whether the configuration parameter is set in the Designer. Otherwise, set the configuration parameter and compile the database.

    Other configuration parameters are installed when the module is installed. Check the configuration parameters and modify them as necessary to suit your requirements.

  3. Install and configure a synchronization server and declare the server as Job server in One Identity Manager.
  4. Synchronize the Active Directory or LDAP environment, SharePoint is going to run on.

    For more detailed information about synchronizing with Active Directory, see the One Identity Manager Administration Guide for Connecting to Active Directory. For more detailed information about synchronizing with LDAP, see the One Identity Manager Administration Guide for Connecting to LDAP.

    IMPORTANT: To prevent inconsistent data, the Active Directory or LDAP environment on which the SharePoint environment is based must always be synchronized first. Once this synchronization has been successfully completed you can start the SharePoint farm synchronization.

    If you cannot ensure synchronization, define custom processes for connecting SharePoint user accounts and user policies with the corresponding authentication objects.

  5. Create a synchronization project with the Synchronization Editor.

NOTE: To create a synchronization project, start the Synchronization Editor on the synchronization server or a remote server. For more detailed information about the archiving process, see the One Identity Manager Target System Synchronization Reference Guide.
Detailed information about this topic

Users and Permissions for Synchronizing with a SharePoint Farm

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

Table 2: Users for synchronization
Users Permissions
User for accessing the SharePoint farm The connector uses the server farm account to log in to the SharePoint farm during synchronization. Ensure the server farm account login data is available.

There is no sensible minimum configuration recommended, which effectively differentiates its permissions from the server account. Membership of the "Farm Administrators" group alone is not sufficient.

One Identity Manager Service user account

The One Identity Manager Service farm's server farm account must be used as user account for SharePoint.

The user account for One Identity Manager Service requires additional rights to carry out operations at file level, for example, assigning user rights and creating and editing directories and files.

The user account must belong to the Domain users group.

The user account must have the Login as a service extended user right

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

NOTE: If 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 installation directory in order to automatically update One Identity Manager Service.

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 Synchronization default system user is provided for executing synchronization with an application server.

Setting Up the Synchronization Server

You will need a synchronization server to synchronize a SharePoint environment. You can use any SharePoint farm SharePoint server for this. The following software must to be installed on the synchronization sever.

To synchronize a SharePoint 2010 environment

  • Windows Server Server 2008 R2 (prerequisite for SharePoint Server 2010)
  • Microsoft SharePoint Server 2010
  • Microsoft .NET Framework Version 4.7.2 or later

    NOTE: Take the target system manufacturer's recommendations into account.
  • One Identity Manager Service, SharePoint connector
    • Install One Identity Manager components with the installation wizard.
      1. Select Select installation modules with existing database.
      2. Select the machine role Server | Job server | SharePoint.

To synchronize a SharePoint 2013 or 2016 environment

  • Windows Server 2008 R2 or Windows Server 2012
  • Microsoft SharePoint Server 2013 or 2016 respectively
  • Microsoft .NET Framework Version 4.7.2 or later

    NOTE: Take the target system manufacturer's recommendations into account.
  • One Identity Manager Service, SharePoint connector
    • Install One Identity Manager components with the installation wizard.
      1. Select Select installation modules with existing database.
      2. Select the machine role Server | Job server | SharePoint.

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Data entries required 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.

Use the Server Installer to install the One Identity Manager Service. The 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.

  • Configuration of 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.

For remote installation of One Identity Manager Service, you require an administrative workstation on which the One Identity Manager components are installed. For detailed information about installing a workstation, see the One Identity Manager Installation Guide.

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

  1. Start the program Server Installer on your administrative workstation.

  2. Enter the valid connection credentials for the One Identity Manager database on the Database connection page.

  3. Specify the server on which you want to install One Identity Manager Service on the Server properties page.

    1. Select a Job server from the Server menu.

      - OR -

      To create a new Job server, click Add.

    2. Enter the following data for the Job server.

      Table 3: Job Server Properties

      Property

      Description

      Server

      Job server name.

      Queue

      Name of the 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 server name in accordance with DNS syntax.

      Example:

      <Name of servers>.<Fully qualified domain name>

      NOTE: You can use the Extended option to make changes to other properties for the Job server. You can also edit the properties later with Designer.
  4. Select SharePoint on the Machine roles page.

  5. Select SharePoint connector on the Server functions page.

  6. Check the One Identity Manager Service configuration on the Service settings page.

    NOTE: The initial service configuration is predefined already. If further changes need to be made to the configuration, you can do this later with the Designer. For detailed information about configuring the service, see the 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 Select installation source.

  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 a name for the server.

      - OR -

    • Select a entry from the list.

    Service account

    User account data for the One Identity Manager Service.

    To enter a user account for the One Identity Manager Service

    • Enter user account, password and password confirmation.

      The One Identity Manager Service farm's server farm account must be used as user account for SharePoint.

    Installation account

    Data for the administrative user account to install the service.

    To enter an administrative user account for installation

    • Enable Advanced.

    • Enable 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 Server Installer.

    NOTE: The service is entered with the name One Identity Manager Service in the server service management.

Creating a Synchronization Project for initial Synchronization of a SharePoint Farm

Use the Synchronization Editor to set up synchronization between the One Identity Manager database and SharePoint. The following describes the steps for initial configuration of a synchronization project.

A synchronization project collects all the information required for synchronizing the One Identity Manager database with a target system. Connection data for target systems, schema types and properties, mapping and synchronization workflows all belong to this.

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

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

Table 5: Information required for setting up a synchronization project
Data Explanation
SharePoint version One Identity Manager supports synchronization with SharePoint 2010, 2013 and 2016.
User account and password for SharePoint farm login To access SharePoint objects, the connector logs in with the server farm account to the SharePoint farm. The server farm account's user name and password are required. For more information, see Users and permissions for synchronizing with a SharePoint farm.
Domain Server farm account domain.

synchronization server

All One Identity Manager Service actions are executed against the target system environment on the synchronization server. Data entries required for synchronization and administration with the One Identity Manager database are processed by the synchronization server.

Installed components:

  • SharePoint server
  • One Identity Manager Service (started)
  • Synchronization Editor
  • SharePoint connector

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

For more information, see Setting up the synchronization server.

Remote connection server

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. Sometimes direct access from the workstation on which the Synchronization Editor is installed is not possible, because of the firewall configuration, for example, or because the workstation does not fulfill the necessary hardware and software requirements. If you cannot start the Synchronization Editor on the synchronization server, you can set up a remote connection.

To use a remote connection

  1. Provide a workstation on which the Synchronization Editor is installed.

  2. Install the RemoteConnectPlugin on the synchronization server.

    The synchronization server then simultaneously assumes the function of the remote connection server.

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

  • SharePoint connector is installed

  • Target system specific components are installed

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

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

One Identity Manager database connection data

  • Database server

  • Database

  • SQL Server Login and password

  • Specifies whether integrated 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.

There is an wizard to assist you with setting up a synchronization project. This wizard takes you all the steps you need to set up initial synchronization with a target system. Click Next once you have entered all the data for a step.

NOTE: The following sequence describes how you configure a synchronization project if Synchronization Editor is both:
  • executed In default mode, and

  • started from the launchpad

If you execute the project wizard in expert mode or directly from Synchronization Editor, additional configuration settings can be made. Follow the project wizard instructions through these steps.

To set up an initial synchronization project for a SharePoint farm

  1. Start the Launchpad on the synchronization server 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 Target system type SharePoint and click Start.

    This starts the Synchronization Editor's project wizard.

  1. On the System access page, specify how One Identity Manager can access the target system.
    • If you started the launch pad on the synchronization server, do not change any settings.
    • If you started the launch pad on the gateway server, do not change any settings.

      Enable the option Connect using remote connection server and under Job server select the synchronization server with which the connection should be established.

  1. Enter the connection data for the SharePoint farm in the system connection wizard. You can test the connection and save the connection data.
    • Enter the following connection data.
      Table 6: Connection data for the SharePoint farm
      Property Description
      SharePoint version Select version 2010 or 2013 of SharePoint.
      Domain Server farm account domain.
      User account and password User name and password for the server farm account.

      This user account is used to synchronize SharePoint objects.

    • Click Test now to test the connection data.

      The Synchronization Editor attempts to connect to the SharePoint farm.

    • To save the connection data, enable Save connection data on local computer. This can be reused when you set up other synchronization projects.
  1. On the One Identity Manager Connection tab, test the data for connecting to the One Identity Manager database. The data is loaded from the connected database. Reenter the password.

    NOTE: If you use an unencrypted One Identity Manager database and have not yet saved any synchronization projects to the database, you need to enter all connection data again. This page is not shown if a synchronization project already exists.
  2. 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. On the Restrict target system access page, you specify how system access should work. You have the following options:
    Table 7: Specify target system access
    Option Meaning

    Read-only access to target system.

    Specifies whether a synchronization workflow is only to be set up for the initial loading of 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 for synchronization in the direction of One Identity Manager

    Read/write access to target system. Provisioning available.

    Specifies whether a provisioning workflow is to be set up in addition to the synchronization workflow for the initial loading of the target system.

    The provisioning workflow displays the following characteristics:

    • Synchronization is in the direction of the Target system.
    • Processing methods are only defined in the synchronization steps for synchronization in the direction of the 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 declared as a Job server in the One Identity Manager database yet, you can add a new Job server.

    1. Click to add a new Job server.

    2. Enter a name for the Job server and the full server name conforming to DNS syntax.

    3. Click OK.

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

      NOTE: After you save the synchronization project, ensure that this server is set up as a synchronization server.
  1. To close the project wizard, click Finish.

    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 you do not want the synchronization project to be activated immediately, disable the Activate and save the new synchronization project automatically option. In this case, save the synchronization project manually before closing the Synchronization Editor.

    NOTE: The connection data for the target system is saved in a variable set and can be modified under Configuration | Variables in Synchronization Editor.

To configure the content of the synchronization log

  1. Open the synchronization project in the Synchronization Editor.

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

    NOTE: Some content generates a particularly large volume of log data. The synchronization log should only contain data required for troubleshooting and other analyses.

  7. Click OK.

To synchronize on a regular basis

  1. Open the synchronization project in the Synchronization Editor.

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

To start initial synchronization manually

  1. Open the synchronization project in the Synchronization Editor.

  2. Select the category Configuration | Start up configurations.

  3. Select a start up configuration in the document view and click Execute.

  4. Confirm the security prompt with Yes.

NOTE:

Following a synchronization, employees are automatically assigned in the default installation. If an account definition for the site collection is not yet known at the time of synchronization, user accounts are linked with employees. However, account definitions are not assigned. The user accounts are therefore in a Linked state.

To manage the user accounts using account definitions, assign an account definition and a manage level to these user accounts.

To select user accounts through account definitions

  1. Create an account definition.
  2. Assign an account definition to the site collection.
  3. Assign the account definition and manage level to user accounts in linked status.
    1. In Manager, select SharePoint | User accounts (user authenticated) | Linked but not configured | <Site collection>.
    2. In Manager, select SharePoint Online | User accounts (user authenticated) | Linked but not configured | <Site collection>.
    3. Select Assign account definition to linked accounts.
Detailed information about this topic
  • For more information, see the One Identity Manager Target System Synchronization Reference Guide.
Related Topics
Related Documents