Chat now with support
Chat with Support

Identity Manager 9.2.1 - Administration Guide for Integration with OneLogin Cloud Directory

Integration with OneLogin Cloud Directory Synchronizing a OneLogin domain
Setting up initial synchronization with a OneLogin domain Customizing the synchronization configuration Running synchronization Tasks following synchronization Troubleshooting Ignoring data error in synchronization Pausing handling of target system specific processes (Offline mode)
Managing OneLogin user accounts and identities Managing memberships in OneLogin roles Login credentials for OneLogin user accounts Mapping OneLogin objects in One Identity Manager
OneLogin domains OneLogin user accounts OneLogin applications OneLogin roles OneLogin authentication methods OneLogin service providers OneLogin clients OneLogin scopes OneLogin policies OneLogin groups OneLogin privileges OneLogin custom user fields Reports about OneLogin objects
Handling of OneLogin objects in the Web Portal Base data for OneLogin domains Configuration parameters for managing OneLogin domains Default template for OneLogin domains Editing OneLogin system objects OneLogin connector settings

System requirements for the OneLogin synchronization server

To set up synchronization with a OneLogin domain, a server has to be available that has the following software installed on it:

  • Windows operating system

    The following versions are supported:

    • Windows Server 2022

    • Windows Server 2019

    • Windows Server 2016

    • Windows Server 2012 R2

    • Windows Server 2012

  • Microsoft .NET Framework version 4.8 or later

    NOTE: Take the target system manufacturer's recommendations into account.

Installing One Identity Manager Service with a OneLogin connector

The One Identity Manager Service with the OneLogin machine role is installed on the synchronization server. The OneLogin machine role contains the OneLogin connector. The OneLogin connector is implemented for synchronizing and provisioning OneLogin domain objects.

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

Table 3: Properties of the Job server
Property Value
Server function

OneLogin connector

Machine role Server | Job Server | OneLogin

NOTE: If several target system environments of the same type are synchronized under the same synchronization server, it is recommended that you set up a Job server for each target system for performance reasons. This avoids unnecessary swapping of connections to target systems because a Job server only has to process tasks of the same type (re-use of existing connections).

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

  2. On the Server functions page, select OneLogin 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 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 OneLogin domain

NOTE: In certain circumstances, specific OneLogin API endpoints can only be enabled by support. For more information about the OneLogin API, see https://developers.onelogin.com/api-docs/1/getting-started/dev-overview and https://developers.onelogin.com/api-docs/2/getting-started/dev-overview.

Use the Synchronization Editor to configure synchronization between the One Identity Manager database and a OneLogin domain. 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.

For more information about setting up synchronization, see the One Identity Manager Target System Synchronization Reference Guide.

Detailed information about this topic

Information required to set up a synchronization project

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

Table 4: Information required to set up a synchronization project
Data Explanation
Domain

Full OneLogin domain name.

Example:

<your domain>.onelogin.com

URI of API

URL for reaching the API. Only the part of the URL used in common by all endpoints to be called, is required.

If the complete URL is https://my-identities.onelogin.com/api/2, then enter api as the URI here. The version part and the object type part are given in the resource configuration.

Authentication endpoint

URL available for authenticating. Only the part of the URL added to the common part, is required to reach the authentication endpoints. If authentication of another server or another root URL is used for authentication, the full URL is required.

If the complete URI is https://my-identities.onelogin.com/api/auth/oauth2/token, enter auth/oauth2/token here. If the base URL or the server is different to the resource URL, enter the full URL, for example https://api.us.onelogin.com/auth/oauth2/v2/token.

Client secret

or

User account and password for logging in

Base64-encrypted client secret or combination of user name and password for logging in.

You obtain the client secret when you register your application with OneLogin. For more information about OneLogin, see your OneLogin documentation.

If both credentials are present, the security token is preferred.

Application/Client ID

Client ID for the application.

You obtain the client ID when you register your application with OneLogin. For more information about OneLogin, see your OneLogin documentation.

Synchronization server for the OneLogin domain

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 One Identity Manager Service with the OneLogin 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.

  • Server function: OneLogin connector

  • Machine role: Server | Job Server | OneLogin

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.

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.

Remote connection server configuration:

  • One Identity Manager Service is started

  • RemoteConnectPlugin is installed and an authentication method is set up

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.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating