Connecting a target system using the PowerShell connector
You can use the PowerShell connector to connect target systems to One Identity Manager that are not directly supported in One Identity Manager. PowerShell cmdlets are used to run read and write operations in the target system.
The PowerShell connector does not provide a project template for setting up synchronization. You must create synchronization configuration components (mappings, workflows, start up configurations ...) manually after the synchronization project has been saved.
NOTE: You need strong knowledge of PowerShell to set up synchronization with the PowerShell connector.
To set up synchronization with the PowerShell connection
- Install and configure a synchronization server and declare the server as a Job server in One Identity Manager.
-
Provide One Identity Manager users with the required permissions for setting up synchronization and post-processing synchronization objects.
- Create a synchronization project with the Synchronization Editor.
Detailed information about this topic
Users and permissions for synchronizing
In the synchronization process with the PowerShell connector, there are three use cases for mapping synchronization objects in the One Identity Manager data model.
-
Mapping custom target systems
-
Mapping in default tables (such as Person, Department)
-
Mapping custom tables
In the case of One Identity Manager tools non role-based login, it is sufficient to add a system user in the DPR_EditRights_Methods and QBM_LaunchPad permissions groups. For more information about system users and permissions groups, see the One Identity Manager Authorization and Authentication Guide.
Table 1: Users and permissions groups for non role-based login
|
One Identity Manager administrators |
administrator and administrative system users Administrative system users are not added to application roles.
administrators:
-
Create customized permissions groups for application roles for role-based login to administration tools in the Designer as required.
-
Create system users and permissions groups for non role-based login to administration tools in the Designer as required.
-
Enable or disable additional configuration parameters in the Designer as required.
-
Create custom processes in the Designer as required.
-
Create and configure schedules as required. |
|
System users in the DPR_EditRights_Methods permissions group |
|
|
System users in the QBM_LaunchPad permissions group |
|
There are different steps required for role-based login, in order to equip One Identity Manager users with the required permissions for setting up synchronization and post-processing of synchronization objects.
Table 2: User and permissions groups for role-based login: Mapped as custom target system
|
One Identity Manager administrators |
administrator and administrative system users Administrative system users are not added to application roles.
administrators:
-
Create customized permissions groups for application roles for role-based login to administration tools in the Designer as required.
-
Create system users and permissions groups for non role-based login to administration tools in the Designer as required.
-
Enable or disable additional configuration parameters in the Designer as required.
-
Create custom processes in the Designer as required.
-
Create and configure schedules as required. |
|
Target system administrators |
Target system administrators must be assigned to the Target systems | Administrators application role.
Users with this application role:
-
Administer application roles for individual target system types.
-
Specify the target system manager.
-
Set up other application roles for target system managers if required.
-
Specify which application roles for target system managers are mutually exclusive.
-
Authorize other identities to be target system administrators.
-
Do not assume any administrative tasks within the target system. |
|
Target system managers |
Users with this application role:
-
Assume administrative tasks for the target system.
-
Create, change, or delete target system objects.
-
Edit password policies for the target system.
-
Can add identities that do not have the Primary identity identity type.
-
Configure synchronization in the Synchronization Editor and define the mapping for comparing target systems and One Identity Manager.
-
Edit the synchronization's target system types and outstanding objects.
-
Authorize other identities within their area of responsibility as target system managers and create child application roles if required. |
Table 3: User and permissions groups for role-based login: Default table mapping
|
One Identity Manager administrators |
administrator and administrative system users Administrative system users are not added to application roles.
administrators:
-
Create customized permissions groups for application roles for role-based login to administration tools in the Designer as required.
-
Create system users and permissions groups for non role-based login to administration tools in the Designer as required.
-
Enable or disable additional configuration parameters in the Designer as required.
-
Create custom processes in the Designer as required.
-
Create and configure schedules as required. |
|
Custom application role |
Users with this application role:
The application role gets its permissions through a custom permissions group and the vi_4_SYNCPROJECT_ADMIN permissions group. |
Table 4: Users and permissions groups for role-based login: Custom table mapping
|
One Identity Manager administrators |
administrator and administrative system users Administrative system users are not added to application roles.
administrators:
-
Create customized permissions groups for application roles for role-based login to administration tools in the Designer as required.
-
Create system users and permissions groups for non role-based login to administration tools in the Designer as required.
-
Enable or disable additional configuration parameters in the Designer as required.
-
Create custom processes in the Designer as required.
-
Create and configure schedules as required. |
|
Application roles for custom tasks |
Administrators must be assigned to the Custom | Administrators application role.
Users with this application role:
|
|
Manager for custom tasks |
Managers must be assigned to the Custom | Managers application role or a child role.
Users with this application role:
-
Add custom task in One Identity Manager.
-
Configure and start synchronization in the Synchronization Editor.
-
Edit the synchronization's target system types as well as outstanding objects in the Manager.
You can use these application roles, for example, to guarantee One Identity Manager user permissions on custom tables or columns. All application roles that you define here must obtain their permissions through custom permissions groups.
The application role gets its permissions through a custom permissions group and the vi_4_SYNCPROJECT_ADMIN permissions group. |
To configure synchronization projects and target system synchronization (in the use cases 2 and 3)
-
Set up a custom permissions group with all permissions for configuring synchronization and editing synchronization objects.
-
Assign a custom application role to this permissions group.
Detailed information about this topic
Setting up custom application roles for synchronization
For role-based login, create a custom application role to guarantee One Identity Manager users the necessary permissions for configuring synchronization and handling outstanding objects. This application role obtains the required permissions by using a custom permissions group.
To set up an application role for synchronization (use case 2):
-
In the Manager, select the default application role to use to edit the objects you want to synchronization.
If you want to import identity main data, for example, select the Identity Management | Identities | Administrators application role. The default permissions group of this application role is vi_4_PERSONADMIN.
-
In the Designer, create a new permissions group .
-
Make the new permissions group dependent on the vi_4_SYNCPROJECT_ADMIN permissions group.
Then the vi_4_SYNCPROJECT_ADMIN permissions groups must be assigned as the parent permissions group. This means that the new permissions group inherits the properties.
-
Make the new permissions group dependent on the default permissions group of the selected default application role.
Then the default permissions groups must be assigned as the parent permissions group. This means that the new permissions group inherits the properties.
- Save the changes.
-
In the Manager, create a new application role.
-
Assign the selected application role to be the parent application role.
-
Assign the newly created permissions group.
-
Assign identities to this application role.
- Save the changes.
To set up an application role for synchronization (use case 3):
-
In the Designer, create a new permissions group for custom tables that are populated by synchronization.
-
Guarantee this permissions group all the required permissions to the custom tables.
-
Create another permissions group for synchronization.
-
Make the permissions group for synchronization dependent on the permissions group for custom tables.
Then the permissions group for custom tables must be assigned as the parent permissions group. This means the permissions groups for synchronization inherits its properties.
-
Make the permissions group for synchronization dependent on the vi_4_SYNCPROJECT_ADMIN permissions group.
Then the vi_4_SYNCPROJECT_ADMIN permissions groups must be assigned as the parent permissions group. This means the permissions groups for synchronization inherits its properties.
- Save the changes.
-
In the Manager, create a new application role.
-
Assign the Custom | Managers application role as the parent application role.
-
Assign the permissions group for the synchronization.
-
Assign identities to this application role.
- Save the changes.
For more information about setting up application roles and permissions groups, see the One Identity Manager Authorization and Authentication Guide.
Setting up the synchronization server
A server with the following software must be available for setting up synchronization:
-
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.
-
Windows Installer
-
Windows Management Framework 4.0 or PowerShell Version 3.0 or later
-
Target system-specific PowerShell modules or snap-ins
-
One Identity Manager Service
- Install One Identity Manager components with the installation wizard.
-
Select the Select installation modules with existing database option.
-
Select the Server | Job Server machine role.
For more information about system requirements for installing the One Identity Manager Service, see the One Identity Manager Installation Guide.
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 synchronization server must be declared as a Job server in One Identity Manager.
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.
-
Select a Job server from the Server menu.
- OR -
To create a new Job server, click Add.
-
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.
-
On the Server functions page, select PowerShell 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:
-
In the module list, select Process collection > sqlprovider.
-
Click the Connection parameter entry, then click the Edit button.
-
Enter the connection data for the One Identity Manager database.
-
Click OK.
For a connection to the application server:
-
In the module list, select the Process collection entry and click the Insert button.
-
Select AppServerJobProvider and click OK.
-
In the module list, select Process collection > AppServerJobProvider.
-
Click the Connection parameter entry, then click the Edit button.
-
Enter the address (URL) for the application server and click OK.
-
Click the Authentication data entry and click the Edit button.
-
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.
-
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.
