Latest update: 7.1.6
- Overview
- About the ForgeRock Open Connector Framework and ICF Connectors
- Using the ICF API
- Implementing the ICF SPI
- Deciding on the Connector Type
- Implementing the Configuration Interface
- Implementing the Connector Interface
- Implementing the Operation Interfaces
- Common Exceptions
- AlreadyExistsException
- ConfigurationException
- ConnectionBrokenException
- ConnectionFailedException
- ConnectorException
- ConnectorIOException
- ConnectorSecurityException
- InvalidAttributeValueException
- InvalidCredentialException
- InvalidPasswordException
- OperationTimeoutException
- PasswordExpiredException
- PermissionDeniedException
- PreconditionFailedException
- PreconditionRequiredException
- RetryableException
- UnknownUidException
- NullPointerException (c# NullReferenceException)
- UnsupportedOperationException (c# NotSupportedException)
- IllegalStateException (c# InvalidOperationException)
- IllegalArgumentException (c# ArgumentException)
- Mapping ICF Exceptions to ForgeRock® Common REST Exceptions
- Generic Exception Rules
- Writing Java Connectors
- Writing Scripted Connectors With the Groovy Connector Toolkit
- About the Groovy Scripting Language
- Selecting a Scripted Connector Implementation
- Implementing ICF Operations With Groovy Scripts
- Variables Available to All Groovy Scripts
- Writing an Authenticate Script
- Writing a Test Script
- Writing a Create Script
- Writing a Search or Query Script
- Writing an Update Script
- Writing a Delete Script
- Writing a Synchronization Script
- Writing a Schema Script
- Writing a Resolve Username Script
- Writing a Run On Resource Script
- Writing a Run On Connector Script
- Advanced - Customizing the Configuration Initialization
- Writing Scripted Connectors With the PowerShell Connector Toolkit
- Troubleshooting Connectors
Before You Begin
Important
Connectors continue to be released outside the IDM release. For the latest documentation, refer to the ICF documentation.
Before you start developing your own connector, familiarize yourself with the structure of the SPI, by reading Implementing the ICF SPI and the corresponding Javadoc for the ICF framework and its supported operations.