Chat now with support
Chat with Support

Identity Manager 8.1.4 - Administration Guide for Connecting to Cloud Applications

Synchronizing cloud applications through Universal Cloud Interface Setting up synchronization with a cloud application Base data for managing cloud applications Cloud applications Container structures in a cloud application User accounts in a cloud application Groups in a cloud application Permissions controls in a cloud application Provisioning object changes Managing provisioning processes in the Web Portal Additional information for experts Default project template for cloud applications

Users and permissions for synchronizing with a cloud application

The following users are involved in synchronizing One Identity Manager with a cloud application.

Table 2: Users for synchronization
User Permissions
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)
Security tokens or users for accessing the cloud application Security tokens or user name and password for use as authentication in the cloud application.

User for accessing the One Identity Manager database

The Synchronization default system user is provided to execute synchronization with an application server.

Setting up a synchronization server

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

  • Windows operating system

    The following versions are supported:

    • Windows Server 2008 R2 (non-Itanium based 64-bit) service pack 1 or later

    • Windows Server 2012

    • Windows Server 2012 R2

    • Windows Server 2016

    • Windows Server 2019

  • Microsoft .NET Framework Version 4.7.2 or later

    NOTE: Take the target system manufacturer's recommendations into account.
  • Windows Installer
  • One Identity Manager Service, Synchronization Editor, SCIM 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 | SCIM machine role.

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

  5. On the Server functions page, select SCIM 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 One Identity Manager database and cloud application. 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.

NOTE: Be aware of case sensitive parts of the URL during configuration.
Table 3: Information required for setting up a synchronization project
Data Explanation

Server URL

URL for reaching the server including the transfer protocol.

Port Port for accessing the cloud application.
URI service URL for reaching the SCIM service.
Authentication endpoint or URL URL available for authenticating. If authentication of another server or another root URL is used for authentication, the full URL must be entered here.
Authentication type Permitted type of authentication for logging into the cloud application.
User account and password User name and password for logging into the cloud application with the "Basic authentication", "OAuth authentication", and "Negotiated authentication" authentication types.
Client secret Security token for logging into the cloud application with the "OAuth authentication" authentication type.

Application/Client ID

The application/client ID used to register the cloud application with the security token service. It is required for registering with the "OAuth authentication" authentication type.

SCIM endpoint Endpoint URIs or URLs for accessing the cloud application's schema, resource, and service provider data.

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 SCIM 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 4: Additional properties for the Job server
Property Value
Server function SCIM connector
Machine role Server/Job server/SCIM

For more information, see Setting up a 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

  • SCIM 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 SCIM 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. On the Configuration data page, enter the connection parameters required by the SCIM connector to login to the cloud application.
    Table 5: Server parameter

    Property

    Description

    Server URL

    URL for reaching the server. Enter the transfer protocol to use.

    Port

    Port for accessing the cloud application. This field can be left empty if default ports are used (HTTP:80, HTTPS:443).

    Service URI

    URL for reaching the SCIM service. Only the part of the URL used in common by all endpoints to be called, is required. The SCIM connector take the URL from the server URL, the port and URI together.

    For example, if the full URL is "https://identities.example.net:8080/scim/v2", then enter "scim/v2" as the URI.

    Table 6: Authentication type
    Property Description
    Basic Authentication Authentication with user name and password.
    OAuth Authentication Authentication using the OAuth protocol 2.0.
    Negotiated authentication (NTLM/Kerberos) Authentication using Windows authentication methods such as NTLM or Kerberos.
    Authentication endpoint or URL

    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 must be entered here.

    Example: If the full URI is "https://identities.example.net:8080/scim/v2/auth/token", enter "auth/token" in this case. If the base URL or the server is different to the resource URL, enter the full URL, for example "https://authserver.example.net/token".

    • On the Basic authentication page, enter the user name and password for the "Basic Authentication" authentication type.

    • On the OAuth authentication page, enter the security token for the "OAuth authentication" authentication type and select the access type.

      Table 7: Features of OAuth Authentication

      Property

      Description

      Client secret

      Security token for logging into the cloud application.

      If the client secret is not known, enter the user name and password.

      User name and password

      User name and password for logging into the cloud application if the security token is not known.

      Application/client ID

      The application/client ID used to register the cloud application with the security token service.

      Grant type

      Security token for logging into the cloud application with the "OAuth authentication" type. Enable Client credentials or Password credentials.

      Scope

      Scope parameter valid for target system login. If several parameter apply, separate them with spaces.

      Whether a scope is required for logging in and which scope parameters are valid, depends on the service provider.

    • On the Negotiated authentication page, enter the user name and password for the "Negotiated authentication (NTLM/Kerberos)" authentication type.
    • On the Client certificate page, select the certificate you want to use. Certificates can imported into the local computer's certificate store from *.CER or *.PFX files.
  2. On Verify connection settings page, you can test the connection. Click Test.

    One Identity Manager tries to connect to the cloud application.

    TIP: One Identity Manager saves the test result. When you reopen the page and the connection data has not changed, the result of the test is displayed. You do not have to run the connection test again if it was successful.

  3. On the Endpoint configuration page, enter the URIs for the SCIM end points. The SCIM default is used there is no URI.
    Table 8: End point configuration
    Property Description
    Schema End point for accessing the schema information for the cloud application.
    Resources End point for accessing resource information for the cloud application, for example groups or user accounts.
    Supported service options End point for accessing the service provider information for the cloud application.

    • To test the connection at the specified end points, click Test.

      TIP: One Identity Manager saves the test result. If you reopen the page and the end point configuration has not changed, the save test result is displayed.

  4. On the Local cache page, you can configure additional setting for optimizing synchronization performance.

    Table 9: Local cache

    Property

    Description

    Use local cache

    Specifies whether the SCIM connector's local cache is used.

    Local cache is used to speed up synchronization. Access to the cloud application is minimized during full synchronization. The option is ignored during provisioning.

    This option is set by default.

    It does not make sense to use the cache during synchronization with revision filtering. If the target system supports revision filtering, disable the option after initial synchronization.

  5. On the Target product selection page, you can customize how the SCIM connector behaves with the singularities of special target products, for example HTTP request formats.
    Table 10: Target products
    Property Description
    SCIM Core V 2.0 Product for synchronizing a SCIM environment.
    One Identity Starling Connect
    Product for synchronizing a One Identity Starling Connect environment
  6. On the Display name page, enter a unique display name for the cloud application.

    You can use display names to differentiate between the cloud application in One Identity Manager tools. Display names cannot be changed later.

  7. On the last page of the system connection wizard you can save the connection data locally and finish the system connection configuration.
    • Set the Save connection data on local computer 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. On the Select project template page , select a project template to use for setting up the synchronization configuration.
    Table 11: Standard project templates
    Project template Description
    SCIM synchronization

    Use this project template for initial configuration of the synchronization project for synchronizing a System for Cross-domain Identity Management environment.

    Synchronization of a One Identity Starling Connect environment

    Use this project template for initial configuration of the synchronization project for synchronizing a SCIMenvironment using the One Identity Starling Connect infrastructure.

    NOTE:A default project template ensures that all required information is added in One Identity Manager. This includes mappings, workflows, and the synchronization base object. If you do not use a default project template you must declare the synchronization base object in One Identity Manager yourself.Use a default project template for initially setting up the synchronization project. For custom implementations, you can extend the synchronization project with the Synchronization Editor.
  1. On the Restrict target system access page, specify how system access should work. You have the following options:
    Table 12: 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.

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

For more detailed information, see the One Identity Manager Target System Synchronization Reference Guide.

Related topics

Displaying synchronization results

Synchronization results are summarized in the synchronization log. You can specify the extent of the synchronization log for each system connection individually. One Identity Manager provides several reports in which the synchronization results are organized under different criteria.

To display a synchronization log

  1. Open the synchronization project in the Synchronization Editor.

  2. Select the Logs category.

  3. Click in the navigation view toolbar.

    Logs for all completed synchronization runs are displayed in the navigation view.

  4. Select a log by double-clicking it.

    An analysis of the synchronization is shown as a report. You can save the report.

To display a provisioning log

  1. Open the synchronization project in the Synchronization Editor.

  2. Select the Logs category.

  3. Click in the navigation view toolbar.

    Logs for all completed provisioning processes are displayed in the navigation view.

  4. Select a log by double-clicking it.

    An analysis of the provisioning is shown as a report. You can save the report.

The log is marked in color in the navigation view. This mark shows you the status of the synchronization/provisioning.

TIP: The logs are also displayed in the Manager under the <target system> | synchronization log category.

Synchronization logs are stored for a fixed length of time.

To modify the retention period for synchronization logs

  • In the Designer, enable the DPR | Journal | LifeTime configuration parameter and enter the maximum retention period.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating