> For the complete documentation index, see [llms.txt](https://docs.openiam.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openiam.com/connector-configuration/scriptconnector.md).

# Groovy Script connector

This page describes how to configure and use flexible groovy script connector

To integrate with various applications and support Joiner, Mover, and Leaver processes, OpenIAM utilizes connectors. The role of connectors within the OpenIAM architecture is detailed [in this document](/connector-configuration/connectorconfig.md).

OpenIAM provides a variety of out-of-the-box connectors for commonly used on-premises and SaaS applications, such as Active Directory (AD), Entra ID, AWS, Google Workspace, SAP HANA, Oracle EBS, and more. These connectors enable seamless integration between OpenIAM and target applications by implementing an organization’s business requirements with minimal effort.

However, organizations often need to integrate OpenIAM with custom applications that lack a pre-built connector. These applications may have unique data structures, authentication mechanisms, or API endpoints, making standard connectors (e.g., SCIM or database connectors) insufficient. In such cases, organizations require a flexible integration approach that allows them to define their own logic while leveraging OpenIAM infrastructure.

To address these requirements, OpenIAM offers the following integration options.

* **Groovy Script Connector**. This is a connector framework based on **Groovy**, allowing implementers to focus on integration logic within Groovy scripts while OpenIAM handles the core connector functionality.
* **PowerShell Script Connector** being a connector framework based on **.NET & PowerShell**, enabling implementers to focus on integration logic in PowerShell scripts without needing to implement the core connector logic.
* **Custom Java Connector** is a **fully custom connector** developed in Java. This approach offers maximum flexibility but requires more development time compared to the scripted options above.

The documents in this section focus on the Groovy Script Connector, explaining its capabilities, structure, and implementation guidelines.

* [Configuring the Groovy Script connector](/connector-configuration/scriptconnector/groovyscriptconnector.md).
* [OpenIAM connector request template](/connector-configuration/scriptconnector/connector-request-template.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openiam.com/connector-configuration/scriptconnector.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
