- Overview
- The ForgeRock Identity Connector Framework (ICF)
- Supported Connectors
- Adobe Marketing Cloud Connector
- AS400 connector
- Cerner Connector
- CSV File Connector
- Database Table Connector
- DocuSign Connector
- Google Cloud Platform Connector
- Google Apps Connector
- Groovy Connector Toolkit
- HubSpot Connector
- Kerberos Connector
- LDAP Connector
- Setting Up the Generic LDAP Connector
- Configuring the LDAP Connector to Use SSL and StartTLS
- Controlling What the LDAP Connector Synchronizes
- Using the Generic LDAP Connector With Active Directory
- Constructing the LDAP Search Filter
- OpenICF Interfaces Implemented by the LDAP Connector
- LDAP Connector Configuration
- Marketo Connector
- MongoDB Connector
- MS Graph API Java Connector
- PeopleSoft Connector
- PowerShell Connector Toolkit
- IBM RACF Connector
- Salesforce Connector
- SAP Connector
- Before You Start
- Using the SAP Connector With an SAP HR System
- Using the SAP Connector to Manage SAP Basis System (R/3) Users
- Configuring the SAP Connector For SNC
- Implementation Specifics
- OpenICF Interfaces Implemented by the SAP Connector
- SAP Connector Configuration
- SCIM Connector
- Scripted REST Connector
- Scripted SQL Connector
- ServiceNow Connector
- SSH Connector
- SAP SuccessFactors Connector
- Workday Connector
- Configure Connectors
- Sample Provisioner Files
- Creating Connector Configurations With the Admin UI
- Configure Connectors Over REST
- Setting the Connector Reference Properties
- Setting the Pool Configuration
- Setting the Operation Timeouts
- Setting the Connection Configuration
- Setting the Synchronization Failure Configuration
- Configuring How Results Are Handled
- Specifying What Attributes are Updated
- Specifying the Supported Object Types
- Configuring the Operation Options
- Remote Connectors
- Check External System Status Using REST
- Remove a Connector
- ICF Interfaces
- ICF Operation Options
- Connection Pooling Configuration
- IDM Glossary
Configure Connectors
Important
Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation.
Connectors are configured through the ICF provisioner service. Each connector configuration is stored in a file in your project's conf/ directory, and accessible over REST at the openidm/conf endpoint. Connector configuration files are named project-dir/conf/provisioner.openicf-name where name corresponds to the name of the connector.
If you are creating your own connector configuration files, do not include additional dash characters ( - ) in the connector name, as this might cause problems with the OSGi parser. For example, the name provisioner.openicf-hrdb.json is fine. The name provisioner.openicf-hr-db.json is not.
You can create a connector configuration in the following ways:
Start with the sample provisioner files in the
/path/to/openidm/samples/example-configurations/provisionersdirectory. For more information, see "Sample Provisioner Files".Set up connectors with the help of the Admin UI. Log in to the Admin UI at
https://localhost:8443/admin, then continue with the process described in "Creating Connector Configurations With the Admin UI".Use the service that IDM exposes through the REST interface to create basic connector configuration files. For more information, see "Configure Connectors Over REST".
Use the cli.sh or cli.bat scripts to generate a basic connector configuration. For more information, see "configureconnector".