Chat now with support
Chat with Support

Identity Manager 8.1.5 - Administration Guide for Connecting to a Universal Cloud Interface

Managing Universal Cloud Interface environments Setting up synchronization with a cloud application in Universal Cloud Interface Basic data for managing a Universal Cloud Interface environment Cloud target systems Container structures in a cloud target system Cloud user accounts Cloud groups Cloud permissions controls Provisioning object changes Reports about objects in cloud target systems Configuration parameters for managing cloud target systems Default project template for cloud applications in the Universal Cloud Interface

Users and permissions for synchronizing

The following users are involved in synchronizing One Identity Manager with a cloud application in the Universal Cloud Interface.

Table 3: Users for synchronization
User Permissions
Users for accessing the Cloud Application in the Universal Cloud Interface

To log on to the database containing the Universal Cloud Interface, use:

  • Role-based login: a user with the application role Universal Cloud Interface | Administrators

    - OR -

  • Non role-based login: a system user with the permissions group "DPR_EditRights_Methods".

One Identity Manager Service user account

The user account for One Identity Manager Service requires permissions to carry out operations at file level. For example, assigning permissions 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 permissions.

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

NOTE: If One Identity Manager Service runs under the network service (NT Authority\NetworkService), you can issue access 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 execute synchronization with an application server.

Setting up the synchronization server

A server with the following software must be available for setting up synchronization:

  • One Identity Manager Service

    • Install One Identity Manager components with the installation wizard.

      1. Select Select installation modules with existing database.

      2. Select the Server | Job server machine role.

    For more detailed information about system requirements for installing the One Identity Manager Service, see the One Identity Manager Installation Guide.

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

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

  • Sets up a Job server.

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

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

  • Configures the One Identity Manager Service.

  • Starts the One Identity Manager Service.

NOTE: 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 detailed information about setting up Job servers, see the One Identity Manager Configuration Guide.

NOTE: The program performs a 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 remotely install the One Identity Manager Service, you must have 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 remotely install and configure One Identity Manager Service on a server

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

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

  3. 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 One Identity Manager Service within the network must have a unique queue identifier. The process steps are requested by the Job queue using this unique queue identifier. 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.

  4. On the Machine roles page, select Job server.

  5. On the Server functions page, select Universal Cloud Interface connector.

  6. 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 detailed information about configuring the service, see the One Identity Manager Configuration Guide.

    • For a direct connection to the database:

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

    • For a connection to the application server:

      1. Select Process collection, click the Insert button and select AppServerJobProvider.

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

      3. Enter the connection data for the application server.

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

      5. Select the authentication module. Depending on the authentication module, other data may be required, such as user and password. For detailed information about the One Identity Manager authentication modules, see the One Identity Manager Authorization and Authentication Guide.

  7. To configure remote installations, click Next.

  8. Confirm the security prompt with Yes.

  9. On the Select installation source page, select the directory with the install files.

  10. On the Select private key file page, select the file with the private key.

    NOTE: This page is only displayed when the database is encrypted.

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

    • Computer: Name or IP address of the server that the service is installed and started on.

    • Service account: User account data for the One Identity Manager Service.

      • To start the service under the NT AUTHORITY\SYSTEM account, set the Local system account option.

      • To start the service under another account, disable the Local system account option and enter the user account, password and password confirmation.

    • Installation account: Data for the administrative user account to install the service.

      • To use the current user’s account, set the Current user option.

      • To use another user account, disable the Current user option and enter the user account, password and password confirmation.

    • To change the install directory, names, display names, or description of the One Identity Manager Service, use the other options.

  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: 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 cloud application

Use the Synchronization Editor to set up synchronization between the Cloud Systems Management Module and the Universal Cloud Interface Module. The following describes the steps for initial configuration of a synchronization project.

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 4: Information required for setting up a synchronization project
Data Explanation
Cloud application Name of the cloud application in the Universal Cloud Interface Module to synchronize.

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.

The One Identity Manager Service with the Universal Cloud Interface connector must be installed on the synchronization server.

The synchronization server must be declared as a Job server in One Identity Manager. Use the following properties when you set up the Job server.

Table 5: Additional properties for the Job server
Property Value
Server function Universal Cloud Interface connector
Machine role Server/Job server

For more information, see Setting up the synchronization server.

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.

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 direct access is not possible from the workstation, 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

  • Universal Cloud Interface connector is 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.

NOTE: The following sequence describes how to configure a synchronization project if the Synchronization Editor is both:

  • Executed in default mode

  • Started from the Launchpad

If you execute 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.

To set up initial synchronization project for a cloud application

  1. Start the Launchpad and log in 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 Target system type Universal Cloud Interface entry 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 access is possible from the workstation on which you started the Synchronization Editor, do not change any settings.

    • If access is not possible from the workstation on which you started the Synchronization Editor, you can set up a remote connection.

      Enable the Connect using remote connection server option and select the server to be used for the connection under Job server.

  1. Click Next on the start page of system connection wizard.
  2. Select the database system to which you want to connect on the Select database system page.
  3. Enter the connection data for the database containing the Universal Cloud Interface Module on the Connection parameter page.
    Table 6: SQL Server database connection data
    Data Description

    Server

    Database server.

    Windows authentication

    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.

    User

    SQL Server login name.

    Password

    SQL Server login password.

    Database

    Database.

    • To enter additional information about the database connection, click Advanced options.
    • Click Test to test whether the database is accessible.
  4. Enter the private key for encrypting the database on the Encryption page.
  5. You can save the connection data on the last page of the system connection wizard.
    • Set the Save connection locally option to save the connection data. This can be reused when you set up other synchronization projects.
    • Click Finish, to end the system connection wizard and return to the project wizard.

  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. Select the cloud application to synchronize on the Select cloud application page.
  1. On the Restrict target system access page, 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 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 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.
  1. On the Synchronization server page, select a synchronization server to execute synchronization.

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

    Two start up configurations and two default schedules are created for regular synchronization.

    Table 8: Start up configuration
    Start up configuration Execution interval
    Synchronization of the cloud application Daily
    Synchronization of pending changes Hourly

    The synchronization project is created, saved, and enabled immediately.

    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.

    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 in the Configuration | Variables category in the 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 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 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 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. Open the synchronization project in the Synchronization Editor.

  2. Select the Configuration | Start up configurations category.

  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 created for the user accounts in the default installation. If an account definition for the target system 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 target system.
  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 Cloud target systems | <Target system> | User accounts | Linked but not configured | <Target system> category.
    2. Select the Assign account definition to linked accounts task.

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

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

    5. Save the changes.
Detailed information about this topic
  • One Identity Manager Target System Synchronization Reference Guide
Related topics

Start up configuration

The project wizard adds two start-up configurations that run cloud application synchronization.

  • Synchronization of the cloud application

    The objects of the cloud application, such as user accounts, groups, and group memberships are synchronized. The workflow "Initial synchronization" is used. Synchronization is run on a daily basis with the default schedule.

  • Synchronization of pending changes

    If cloud objects are changed in the Cloud Systems Management Module, these changes must first be transferred to the Universal Cloud Interface Module and can then be provisioned to the cloud application itself. To track whether the changes have been successfully provisioned in the cloud application, they are labeled with "Pending changes". The details, time of creation, and processing status of every pending change are saved. Once provisioning is complete, the processing status must be transferred from the Universal Cloud Interface to the Cloud Systems Management Module. To do this, run the start up configuration "Synchronization of pending changes". This uses the workflow "Initial synchronization". Synchronization is run on an hourly basis with the default schedule.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating