Chat now with support
Chat mit Support

Identity Manager 8.1 - Administration Guide for Connecting to Cloud Applications

Synchronizing Cloud Applications through the 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 Appendix: 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
Users Permissions
One Identity Manager Service user account

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

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

NOTE: If 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 installation directory in order to automatically update One Identity Manager Service.

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)
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 for executing 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

    Following versions are supported:

    • Windows Server 2016

    • Windows Server 2012 R2

    • Windows Server 2012

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

  • 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 Select installation modules with existing database.
      2. Select the machine role Server | Job server | SCIM.

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 Server Installer to install the One Identity Manager Service. The 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.

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

For remote installation of One Identity Manager Service, you require 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 install and configure One Identity Manager Service remotely on a server

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

  2. Enter the valid connection credentials for the One Identity Manager database on the Database connection page.

  3. Specify the server on which you want to install One Identity Manager Service on the Server properties page.

    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.

      Table 3: Job Server Properties

      Property

      Description

      Server

      Job server name.

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

      Example:

      <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 Designer.
  4. Select SCIM on the Machine roles page.

  5. Select SCIM connector on the Server functions page.

  6. Check the One Identity Manager Service configuration on the Service settings page.

    NOTE: The initial service configuration is predefined already. 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.
  7. To configure remote installations, click Next.

  8. Confirm the security prompt with Yes.

  9. Select the directory with the install files on Select installation source.

  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 4: Installation Data

    Data

    Description

    Computer

    Server on which to install and start the service from.

    To select a server

    • Enter a name for the server.

      - OR -

    • Select a entry from the list.

    Service account

    User account data for the One Identity Manager Service.

    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 NT AUTHORITY\SYSTEM account.

      - OR -

    • Enter user account, password and password confirmation.

    Installation account

    Data for the administrative user account to install the service.

    To enter an administrative user account for installation

    • Enable Advanced.

    • Enable 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 Server Installer.

    NOTE: The service is entered with the name One Identity Manager Service in the server service management.

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 5: Information Required for Setting up a Synchronization Project
Data Explanation
Servers DNS name / URL DNS name of the server that provides the SCIM interface or URL for connecting to the server.
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 authentication types "Basic authentication", "OAuth authentication" and "Negotiated authentication".
Client secret Security token for logging into the cloud application with the authentication type "OAuth authentication".

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 authentication type "OAuth-Authentication".

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 6: 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 target system to do this. Sometimes direct access from the workstation on which the Synchronization Editor is installed is not possible, because of the firewall configuration, for example, or because the workstation does not fulfill the necessary hardware and software requirements. If direct access to the workstation is not possible, 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 you configure a synchronization project if Synchronization Editor is both:
  • executed In default mode, and

  • started from the launchpad

If you execute the project wizard in expert mode or directly from 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 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 Target system type SCIM interface and click Start.

    This starts the Synchronization Editor's project wizard.

  1. Specify how One Identity Manager can access the target system on the System access page.

    • If access is possible from the workstation on which you started Synchronization Editor, you do not need to make any settings.

    • If access is not possible from the workstation on which you started 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 7: Server parameter
    Property Description
    Servers DNS name / URL DNS name of the server that provides the SCIM interface or URL for connecting to the server.
    Port Port for accessing the cloud application.
    URI service

    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 8: 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 authentication type "Basic Authentication".
    • On the OAuth authentication page, enter the security token for the authentication type "OAuth authentication" and select the access type.

      Table 9: 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 account 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 "OAuth authentication". Enable Client credentials or Password credentials.

    • On the Negotiated authentication page, enter the user name and password for the authentication type "Negotiated authentication (NTLM/Kerberos)".
  2. You can test the connection on Verify connection settings. Click Test.

    One Identity Manager tries to connect to the cloud application.

    TIP: The 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 10: 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: The 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 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 11: Target products
    Property Description
    SCIM Core V 2.0 Product for the synchronization of a standard SCIM environment.
    One Identity Starling Connect Product for synchronizing a One Identity Starling Connect environment
  5. Enter a unique display name for the cloud application on the Display name page.

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

  6. 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. Select a project template on the Select project template page to use for setting up the synchronization configuration.
    Table 12: 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 SCIM environment 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, you specify how system access should work. You have the following options:
    Table 13: Specify target system access
    Option Meaning

    Read-only access to target system.

    Specifies whether 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.
  2. Select the synchronization server to execute synchronization on the Synchronization server page.

    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 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 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 under Configuration | Variables in 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 category Configuration | Target system.
  3. To configure the synchronization log for the database connection, select Configuration | One Identity Manager connection.
  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 category Configuration | Start up configurations.
  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 category Configuration | Start up configurations.

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

  4. Confirm the security prompt with Yes.
Detailed information about this topic
  • One Identity Manager Target System Synchronization Reference Guide
Related Topics

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

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

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

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

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

Synchronization logs are stored for a fixed length of time.

To modify the retention period for synchronization logs

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

Verwandte Dokumente