Chat now with support
Chat with Support

Identity Manager 8.0 - Administration Guide for Connecting to SharePoint

Managing SharePoint Environments Setting Up SharePoint Farm Synchronization Basic Data for Managing SharePoint 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 SharePoint Appendix: Default Project Template for SharePoint

Setting Up SharePoint Farm Synchronization

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. The One Identity Manager parts for managing SharePoint systems are available if the configuration parameter "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 serverClosed 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 avoid data inconsistency, always synchronize the Active Directory or LDAP environment first on which the SharePoint environment is based. Once this synchronization has been successfully completed you can start the SharePoint farm synchronization.

    If this cannot be guaranteed, define a custom process to link user accounts and user policies to the associated base objects.

  5. Create a synchronization project with the Synchronization EditorClosed.

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

Users and Permissions for Synchronizing with a SharePoint Farm

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
User 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 in the group "Farm Administrators" 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 the One Identity Manager Service requires additional 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.

Setting Up the Synchronization 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.5.2 or later

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

    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 the option Select installation modules with existing database.
      2. Select the machine role Server | Job serverClosed | SharePoint.

To synchronize a SharePoint 2013 environment

  • Windows Server 2008 R2 or Windows Server 2012 (prerequisite for SharePoint Server 2013)
  • Microsoft SharePoint Server 2013
  • 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.
  • One Identity Manager Service, SharePoint 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 server | SharePoint.

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.

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:

    • SharePoint
  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:

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

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

Creating a Synchronization Project for initial Synchronization of a SharePoint Farm

Creating a Synchronization Project for initial Synchronization of a SharePoint Farm

Use the Synchronization EditorClosed 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 SynchronizationClosed 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 The One Identity Manager supports synchronization with SharePoint 2010 and 2013.
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 serverClosed

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.

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 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 cannot start the Synchronization Editor on the synchronization server, because of the firewall configuration, for example, 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.

    Thus, the Synchronisationsserver assumes the function of the remote connection server at the same time.

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

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 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 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 the entry SharePoint 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 started the launch pad on the synchronization server, do not change any settings.
    • If you started the launch pad on a workstation, connect remotely.

      Set the option Connect using remote connection server and select, under Job server, the synchronization server you want to use for the connection.

  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: SharePoint Farm Connection Data
      Property Description
      SharePoint version Select SharePoint Version 2010 or 2013.
      Domain Server farm account domain.
      User name and password User name and password of the server farm account.

      This user account is used to synchronize SharePoint objects.

    • Click Check now to test the connection data.

      The Synchronization Editor tries to log in to the SharePoint farm.

    • To save the connection data, set the option Save connection data on local computer. This can be reused when you set up other synchronization projects.
  1. Verify the One Identity Manager database connection data on the One Identity Manager connection page. The data is loaded from the connected database. Reenter the password.

    NOTE: Reenter all the connection data if you are not working with an encrypted One Identity Manager database and no synchronization project has been saved yet in the database. 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. Specify how system access should work on the page Restrict target system access. You have the following options:
    Table 7: 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.

NOTE: Following synchronization, employees are automatically assigned to user accounts in the default installation. If there are no account definitions for the site collection at the time of synchronization, user accounts are linked to employees. However, account definitions are not assigned. The user accounts are, therefore, in a "Linked" state.

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 the user accounts in a "linked" state.
    1. Select the category SharePoint | User accounts (use authenticated) | Linked but not configured | <site collection>.
    2. Select the task 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