Chat now with support
Chat mit Support

Identity Manager 9.2 - 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 SharePoint site 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 objects Configuration parameters for managing a SharePoint environment 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. Set the TargetSystem | SharePoint configuration parameter to make the One Identity Manager components for managing SharePoint environments available.

    In the Designer, check if the configuration parameter is set. Otherwise, set the configuration parameter and compile the database.

    NOTE: If you disable the configuration parameter at a later date, model components and scripts that are no longer required, are disabled. SQL procedures and triggers are still carried out. For more information about the behavior of preprocessor relevant configuration parameters and conditional compiling, see the One Identity Manager Configuration Guide.

    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 a Job server in One Identity Manager.
  4. Synchronize the Active Directory or LDAP system that SharePoint is going to run on.

    For more information about synchronizing with Active Directory, see the One Identity Manager Administration Guide for Connecting to Active Directory. For more 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 system that SharePoint is running on, must always be synchronized first. Once 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 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
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 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 the One Identity Manager Service requires additional user permissions to carry out operations at file level (adding 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 permissions.

The user account requires permissions for the internal web service.

NOTE: If the One Identity Manager Service runs under the network service (NT Authority\NetworkService), you can grant permissions 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 One Identity Manager.

In the default installation, 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 to run synchronization using 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.

NOTE: You must never use the same synchronization server to run synchronization projects in parallel. Different synchronization servers must never run synchronization projects for the same SharePoint farm in parallel.

If you distribute synchronization of a SharePoint farm over different start up configurations, ensure that they are run in sequence. For more information about setting up start up configurations, see the One Identity Manager Target System Synchronization Reference Guide. For more information, see Customizing the synchronization configuration.

To synchronize SharePoint 2013, 2016, 2019, or the Subscription Edition

  • Windows Server 2008 R2 or Windows Server 2012
  • Microsoft SharePoint Server 2013, 2016, 2019, or the Subscription Edition

  • Microsoft .NET Framework version 4.8 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 the Select installation modules with existing database option.
      2. Select the Server | Job Server | SharePoint machine role.

All One Identity Manager Service actions are run 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.

To set up a Job server, perform the following steps.

  1. Create a Job server and install and configure the One Identity Manager Service.

    Use the One Identity Manager Service to install the Server Installer. The program runs the following steps:

    • Sets up a Job server.

    • Specifies machine roles and server function for the Job server.

    • Installs One Identity Manager Service components corresponding to the machine roles.

    • Configures the One Identity Manager Service.

    • Starts the One Identity Manager Service.

    Use the Server Installer to install the One Identity Manager Service locally or remotely.

    To remotely install the One Identity Manager Service, provide an administrative workstation on which the One Identity Manager components are installed. Ensure that the One Identity Manager components are installed on the server before installing locally. For more information about installing One Identity Manager components, see the One Identity Manager Installation Guide.

  2. If you are working with an encrypted One Identity Manager database, declare the database key in the One Identity Manager Service. For more information about working with an encrypted One Identity Manager database, see the One Identity Manager Installation Guide.

  3. To generate processes for the Job server, you need the provider, connection parameters and the authentication data. By default, this information is determined from the database connection data. If the Job server runs through an application server, you must configure extra connection data in the Designer. For more information about connection data, see the One Identity Manager Configuration Guide.

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

  1. Start the Server Installer program.

    NOTE: To install remotely, start the Server Installer program on your administrative workstation. To install locally, start the program on the server.

  1. On the Database connection page, enter the valid connection credentials for the One Identity Manager database.

    You can connect via the application server or directly to connect to the database.

  2. On the Server properties page, specify the server on which you want to install the One Identity Manager Service.

    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.

      • Server: Name of the Job server.

      • Queue: Name of the queue to handle the process steps. Each Job server within the network must have a unique queue identifier. The process steps are requested by the Job queue using this exact 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.

        Syntax:

        <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 the Designer.

  1. On the Machine roles page, select SharePoint.

  2. On the Server functions page, select SharePoint connector.

  3. On the Service Settings page, enter the connection data and check the One Identity Manager Service configuration.

    NOTE: The initial service configuration is predefined. If further changes need to be made to the configuration, you can do this later with the Designer. For more information about configuring the service, see the One Identity Manager Configuration Guide.

    For a direct connection to the database:

    1. In the module list, select Process collection > sqlprovider.

    2. Click the Connection parameter entry, then click the Edit button.

    3. Enter the connection data for the One Identity Manager database.

    4. Click OK.

    For a connection to the application server:

    1. In the module list, select the Process collection entry and click the Insert button.

    2. Select AppServerJobProvider and click OK.

    3. In the module list, select Process collection > AppServerJobProvider.

    4. Click the Connection parameter entry, then click the Edit button.

    5. Enter the address (URL) for the application server and click OK.

    6. Click the Authentication data entry and click the Edit button.

    7. In the Authentication method dialog, select the authentication module for logging in. Depending on the authentication module, other data may be required, such as user and password. For more information about One Identity Manager authentication modules, see the One Identity Manager Authorization and Authentication Guide.

    8. Click OK.

  4. To configure the installation, click Next.

  1. Confirm the security prompt with Yes.

  2. On the Select installation source page, select the directory with the install files. Change the directory if necessary.

  3. On the Service access page, enter the service's installation data.

    • Computer: Select the server, on which you want to install and start the service, from the menu or enter the server's name or IP address.

      To run the installation locally, select Local installation from the menu.

    • Service account: Enter the details of the user account that the One Identity Manager Service is running under. Enter the user account, the user account's password and password confirmation.

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

    The service is installed using the user account with which you are logged in to the administrative workstation. If you want to use another user account for installing the service, you can enter it in the advanced options.

    You can also change the One Identity Manager Service details, such as the installation directory, name, display name, and the One Identity Manager Service description, using the advanced options.

  4. Click Next to start installing the service.

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

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

    NOTE: In a default installation, the service is entered in the server’s service management with the name One Identity Manager Service.

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 3: Information required for setting up a synchronization project
Data Explanation
SharePoint version One Identity Manager supports synchronization with SharePoint versions 2013, 2016, 2019, and with the SharePoint Server Subscription Edition.
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 run 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 the target system to do this. Sometimes direct access from the workstation, on which the Synchronization Editor is installed, is not possible. For example, because of the firewall configuration or the workstation does not fulfill the necessary hardware and software requirements. If the Synchronization Editor cannot be started directly 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.

    Thus the synchronization server 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 name

  • SQL Server login and password

  • Specifies whether integrated Windows authentication is used

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

There is a wizard to assist you with setting up a synchronization project. This wizard takes you through 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 to configure a synchronization project if the Synchronization Editor is both:

  • Run in default mode

  • Started from the Launchpad

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

NOTE: Just one synchronization project can be created per target system and default project template used.

To set up an initial synchronization project for a SharePoint farm

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

    NOTE: If synchronization is run by an application server, connect the database through the application server.

  2. Select the Target system type SharePoint entry and click Start.

    This starts the Synchronization Editor's project wizard.

  1. On the wizard's start page, click Next.

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

      Enable the Connect using remote connection server option 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 4: SharePoint farm connection data
      Property Description
      SharePoint version

      SharePoint version in use.

      • To connect to SharePoint Server Subscription Edition, select 2019.

      Domain Domain of the server farm account.
      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, specify how system access should work. You have the following options: Read-only access to target system.
    Table 5: Specify target system access
    Option Meaning

    Specifies that 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 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.

  1. On the Synchronization server page, select the synchronization server to run the synchronization.

    If the synchronization server is not declared as a Job server for this target system 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.

      TIP: You can also implement an existing Job server as the synchronization server for this target system.

      • To select a Job server, click .

      This automatically assigns the server function matching this Job server.

    3. Click OK.

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

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

    This sets up, saves and immediately activates the synchronization project.

    NOTE:

    • If enabled, a consistency check is carried out. If errors occur, a message appears. You can decide whether the synchronization project can remain activated or not.

      Check the errors before you use the synchronization project. To do this, in the General view on the Synchronization Editor‘s start page, click Verify project.

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

    • The connection data for the target system is saved in a variable set and can be modified in the Synchronization Editor in the Configuration > Variables category.

To configure the content of the synchronization log

  1. In the Synchronization Editor, open the synchronization project.

  2. To configure the synchronization log for target system connection, select the Configuration > Target system category.

  3. To configure the synchronization log for the database connection, select the Configuration > One Identity Manager connection category.

  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 error analysis and other analyzes.

  7. Click OK.

To synchronize on a regular basis

  1. In the Synchronization Editor, open the synchronization project.

  2. Select the Configuration > Start up configurations category.

  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. In the Synchronization Editor, open the synchronization project.

  2. Select the Configuration > Start up configurations category.

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

  4. Confirm the security prompt with Yes.

NOTE:

In the default installation, after synchronizing, identities are automatically assigned. If an account definition for the site collection is not known at the time of synchronization, user accounts are linked with identities. 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 manage user accounts through account definitions

  1. Create an account definition.

  2. Assign an account definition to the site collection.

  3. Assign a user account in the Linked state to the account definition. The account definition's default manage level is applied to the user account.

    1. In the Manager, select the SharePoint > User accounts (user authenticated) > Linked but not configured > <site collection> category.

    2. In the Manager, select the SharePoint Online > User accounts (user authenticated) > Linked but not configured > <site collection> category.

    3. Select the Assign account definition to linked accounts task.

    4. In the Account definition menu, select the account definition.

    5. Select the user accounts that contain the account definition.

    6. Save the changes.

Detailed information about this topic
  • For more information, see the One Identity Manager Target System Synchronization Reference Guide.
Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen