Chat now with support
Chat with Support

Identity Manager 8.0 - Administration Guide for Connecting to the Universal Cloud Interface

Managing Universal Cloud Interface Environments Setting up Synchronization with a Cloud Application in the Universal Cloud Interface Base Data for Managing Universal Cloud Interface 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 Appendix: Configuration Parameters for Managing Cloud Target Systems Appendix: Default Project Template for Cloud Application in the Universal Cloud Interface

Users and Permissions for Synchronizing

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 the One Identity Manager Service requires access rights to carry out operations at file level (issuing user rights, adding directories and files to be edited).

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

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

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

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

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

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

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

  • %ProgramFiles(x86)%\One Identity (on 32-bit operating systems)
  • %ProgramFiles%\One Identity (on 64-bit operating systems)

User for accessing the One Identity Manager database

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

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

    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 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 4: 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.
    • Job Server
  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.

    • Universal Cloud Interface 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 5: Installation Data
    Data Description
    Computer Server on which to install and start the service from.

    To select a server

    • Enter the server name.

      - OR -

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

    To enter a user account for the One Identity Manager Service

    • Set the option Local system account.

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

      - OR -

    • Enter user account, password and password confirmation.

      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 Cloud Application

Creating a Synchronization Project for Initial Synchronization of a Cloud Application

Use the Synchronization EditorClosed 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 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 6: Information Required for Setting up a Synchronization Project
Data Explanation
Cloud applicationClosed Name of the cloud application in the Universal Cloud Interface Module to synchronize.

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.

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 7: 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 ConnectionClosed Data

SQL Server:

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

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

Oracle:

  • Species whether access is direct or through the Oracle client

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

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

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

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

Remote connection server configuration:

  • One Identity Manager Service is started
  • RemoteConnectPlugin is installed
  • 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 you configure a synchronization project if the Synchronization Editor is both:
  • In default mode
  • Started from the launchpad

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

To set up initial synchronization project for a cloud application

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

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

    This starts the Synchronization Editor's project wizard.

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

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

  1. 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 8: SQL Server Database Connection Data
    Data Description

    Server

    Database server.

    Windows authentication

    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.

    User

    Database user.

    Password

    Database user password.

    Database

    Database.

    Table 9: Oracle Database Connection Data
    Data Description
    Direct access (without Oracle client) Set this option for direct access.

    Deactivate this option for access via Oracle Clients.

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

    Server Database server.
    Port Oracle instance port.
    Service name Service name.
    User Oracle database user.
    Password Database user password.
    Data source TNS alias name from TNSNames.ora.
    • To enter additional information about the database connection, click Advanced options.
    • To test whether you can reach the database, click Test.
  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 option Save connection locally 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. 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. Select the cloud application to synchronize on the Select cloud application page.
  1. Specify how system access should work on the page Restrict target system access. You have the following options:
    Table 10: 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.

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

    Table 11: Start up Configurations
    Start up configurationClosed Execution Interval
    Synchronization of the cloud application Daily
    Synchronization of pending changes Hourly

    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 created for user accounts in the default installation. If there are no account definitions for the target system 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 target system.
  3. Assign the account definition and manage level to the user accounts in a "linked" state.
    1. Select the category Cloud Target Systems | <target system> | User accounts Linked but not configured | <target system>.
    2. Select the task Assign account definition to linked accounts.
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.

  • SynchronizationClosed of the cloud application

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

  • Synchronization of pending changes

    If cloud objects in the Cloud Systems Management Module are changed, the changes must first be transferred to the Universal Cloud Interface Module and then they can be provisioned in 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