- Overview
- The ForgeRock Identity Connector Framework (ICF)
- Supported Connectors
- Adobe Marketing Cloud Connector
- AS400 connector
- AWS Connector
- Cerner Connector
- CSV File Connector
- Database Table Connector
- DocuSign Connector
- Epic Connector
- Google Cloud Platform Connector
- Google Apps Connector
- Groovy Connector Toolkit
- HubSpot Connector
- Kerberos Connector
- LDAP Connector
- 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
- SAP S/4HANA Connector
- SCIM Connector
- Scripted REST Connector
- Scripted SQL Connector
- ServiceNow Connector
- SSH Connector
- SAP SuccessFactors Connector
- Workday Connector
- Configure Connectors
- Sample Provisioner Files
- Configure Connectors With the Admin UI
- Configure Connectors Over REST
- Connector Reference Properties
- Pool Configuration
- Operation Timeouts
- Connection Configuration
- Synchronization Failure Configuration
- Configure How Results Are Handled
- Specify Which Attributes Are Updated
- Set the Supported Object Types
- Configure Operation Options
- Remote Connectors
- Check External System Status Over 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.
You configure connectors through the ICF provisioner service, and access them over REST at the openidm/conf
endpoint.
Connector configurations are stored in files in your project's conf/
directory, and 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 can 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/provisioners
directory. For more information, see "Sample Provisioner Files".Configure connectors in the Admin UI. Log in to the Admin UI at
https://localhost:8443/admin
, then continue with the process described in "Configure Connectors 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".