Identity Manager 9.1.2 - Administration Guide for Connecting to Cloud Applications

The One Identity Manager Service must be installed on the synchronization server with the SCIM connector. 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	SCIM connector
Machine role	Server \| Job Server \| SCIM

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.

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

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.

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

On the Machine roles page, select SCIM.
On the Server functions page, select SCIM connector.
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 string 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 string entry, then click the Edit button.
5. Enter the address (URL) for the application server and click OK.
6. Click the Authentication string 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.
To configure the installation, click Next.

Confirm the security prompt with Yes.
On the Select installation source page, select the directory with the install files. Change the directory if necessary.
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.
Click Next to start installing the service.

Installation of the service occurs automatically and may take some time.
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

Information required for setting up 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 4: Information required for setting up a synchronization project
Data	Explanation
URL of the SCIM server	URL used to connect to the server that deploys the SCIM interface. The URL must contain the transmission protocol in use.
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.
Public key for HPKP	Public key of the certificate to attach if you want to use the HPKP mechanism for limiting usage of the accepted certificate.
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.
Authentication token	Security token for logging into the cloud application with the Bearer authentication authentication type.
SCIM endpoint	Endpoint URIs or URLs for accessing the cloud application's schema, resource, and service provider data.
SCIM server's time zone	Time zone on which the SCIM provider bases its time data.
synchronization server	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 must be installed on the synchronization server with the SCIM connector. 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: SCIM connector Machine role: Server/Jobserver/SCIM For more information, see System requirements for the SCIM synchronization server.
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. 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 establishing a remote connection, see the One Identity Manager Target System Synchronization Reference Guide.

Creating an initial synchronization project for a cloud application

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

Run in default mode
Started from the Launchpad

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

NOTE: Just one synchronization project can be created per target system and default project template used.

To set up initial synchronization project for a cloud application

Start the Launchpad and log in on the One Identity Manager database.

NOTE: If synchronization is run by an application server, connect the database through the application server.
Select the Target system type SCIM interface entry and click Start.

This starts the Synchronization Editor's project wizard.

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.

On the Certificate validation options page, configure the certificate validation settings for encrypted connections.
- If you want to use the HPKP mechanism for limiting usage of the accepted certificate, enter the certificate's public key.

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).
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. Example: If the complete 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 the user name and password.
OAuth authentifcation	Authentication with the OAuth protocol 2.0.
Negotiated authentication (NTLM/Kerberos)	Authentication using Windows authentication methods such as NTLM or Kerberos
Use client certificate	Authentication using a client certificate.
Bearer authentication	Authentication using an existing bearer token.
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 here. If the base URL or the server is different to the resource URL, enter the full URL, for example https://authserver.example.net/token. This URL is only used for testing the connection in all authentication modes apart from OAuth authentication.

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: OAuth authentication properties
Property	Description
Client secret	Security token If the security token 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	Grant type for logging in to the cloud application with the OAuth authentication 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.
On the Bearer authentication page, enter the bearer token calculated by the target system.

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.

On the Endpoint configuration page, enter the URIs for the SCIM end points. The SCIM default is used there is no URI.

Table 8: Endpoint configuration
Property	Description
Schema	Endpoint for accessing the cloud application's schema information.
Resources	End point for accessing the cloud application's resource information, such as groups or user accounts.
Supported service options	Endpoint for accessing the cloud application's service provider information.

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.

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

Table 9: Performance optimization settings
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 not set by default. NOTE: It does not make sense to use the cache when synchronization with revision filtering. If the target system supports revision filtering, disable the option after initial synchronization.
Max. number of parallel queries	Number of target system data queries that can be carried out at simultaneously. Enter a value between 1 and 32.
Use HTTP Keep-Alive	Specifies whether HTTP connections are kept open. If the option is not set, connections are closed immediately and cannot be used for further queries.

On the SCIM server time zone and time out settings page, enter the time on which the SCIM provider bases its time data and configure the timeout for server queries.
- SCIM server time zone: If the SCIM provider supplies time and date values that do not contain any time zone information the time zone given here is used.
- Timeout in ms (100,000 - 500,000): Maximum duration of a server query. If the time is exceeded, the request is canceled. The default value is 100,000 ms. The maximum value is 500,000 ms

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 2.0	Product for synchronizing a standard SCIM environment.
One Identity Starling Connect	Product for synchronizing a standard One Identity Starling Connect environment.

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

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

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.
Synchronizing a One Identity Starling Connect environment	Use this project template for initial configuration of the synchronization project for synchronizing SCIM using 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.

On the Restrict target system access page, specify how system access should work. You have the following options: Read-only access to target system.

Table 12: Specify target system access
Option	Meaning
	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 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.

On the Synchronization server page, select the synchronization server to run the 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 Job server for the target system in the One Identity Manager database.
4. NOTE: After you save the synchronization project, ensure that this server is set up as a synchronization server.

To close the project wizard, click Finish.

This creates and allocates a default schedule for regular synchronization. Enable the schedule for regular synchronization.

This sets up, saves and immediately activates the synchronization project.
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.
- 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.
- The connection data for the target system is saved in a variable set and can be modified in the Synchronization Editor in the Configuration > Variables category.

Identity Manager 9.1.2 - Administration Guide for Connecting to Cloud Applications

Installing One Identity Manager Service with a SCIM connector

Creating a synchronization project for initial synchronization of a cloud application

Detailed information about this topic

Information required for setting up a synchronization project

Creating an initial synchronization project for a cloud application

Detailed information about this topic

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Identity Manager 9.1.2 - Administration Guide for Connecting to Cloud Applications

Installing One Identity Manager Service with a SCIM connector

Creating a synchronization project for initial synchronization of a cloud application

Detailed information about this topic

Information required for setting up a synchronization project

Creating an initial synchronization project for a cloud application

Detailed information about this topic