> 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/connector-request-template.md).
# OpenIAM connector request template
This page contains a template to gather technical information for building a connection with the user's application
The below template will help users to gather the required **technical information** for building a connector that integrates their application’s REST API with OpenIAM. The template below provides **two options** for integration. Please complete the section **applicable to your** target system.
{% hint style="warning" %}
All fields marked as Required must be completed. Incomplete submissions may delay development or require additional follow-up.
{% endhint %}
## REST API Integration
1. **General information**
| Field | Description | Your response |
|---|
| Company Name | Your organization name | |
| Application Name | The target application to integrate with OpenIAM | |
| Primary Technical Contact | Name, email, and role | |
| Environment(s) | Specify usage: Dev / Test / Prod | |
2. **API details** (Required)
| Field | Description | Your response |
| --------------------------- | ----------------------------------------------------------------------------- | ------------- |
| Base API URL | e.g., | |
| API Documentation | Link or attachment (Postman, Swagger, PDF, etc.) | |
| Authentication Type | OAuth2, API Key, Basic Auth, JWT, etc. | |
| Service account credentials | Credential to use if Basic Auth is used. | |
| Token Acquisition | Includes details or sample requests | |
| Test Environment Access | ☐ Yes
☐ No
\*If yes, provide credentials or access steps
| |
3. **User lookup & search operations** (All Required)
| Operation | Endpoint & Method | Notes |
| ---------------------------------- | ----------------------------- | ----- |
| Search Users | e.g., GET `/users?query=...` | |
| List All Users | e.g., GET `/users` | |
| Get User by ID or Username | e.g., GET `/users/{id}` | |
| Get User’s Entitlement Memberships | e.g., GET \`/users/{id}/roles | |
4. **User lifecycle operations**
| Operation | Endpoint & Method | Notes (required fields, constraints, etc.) |
| ------------------------------ | ----------------- | ------------------------------------------ |
| Create User | | |
| Update User | | |
| Delete User | | |
| Disable/Enable User | | |
| Reset Password (if applicable) | | |
5. **Entitlement management** (All Required)
| Field | Description | Your response |
| ------------------------------------------------------------- | ----------------------------------------- | ------------- |
| Does the system support roles, groups, or other entitlements? | ☐ Yes
☐ No
| |
| API to list all available entitlements | e.g., `/roles`, `/groups` | |
| API to assign entitlement to a user | e.g., POST `/users/{id}/roles` | |
| API to remove entitlement from user | e.g., DELETE `/users/{id}/roles/{roleId}` | |
| API to get current entitlements for a user | e.g., GET `/users/{id}/roles` | |
6. **Identity attribute mapping & generation rules**
| Attribute Name | Required? | Source Column | Generation Rule (if applicable) | Collision Handling | Notes |
| -------------- | --------- | ------------------------ | ------------------------------- | ----------------------- | -------------------- |
| username | Yes | first\_name + last\_name | firstName.lastName | Append number if exists | Matches AD identity? |
7. **Security constraints**
| Field | Description | Your response |
| -------------------------------- | ----------------------------------------- | ------------- |
| Rate limits | API quotas, throttling policies | |
| Firewall / IP Allowlist | If yes, provide steps or list OpenIAM IPs | |
| Required Headers / Custom Tokens | Any headers, token exchange steps, etc. | |
7. **Attachments checklist**
Please attach or link to the following items:
* API documentation (Swagger, Postman, PDF, etc.).
* Sample request/response payloads for each operation.
* Test credentials or sandbox access instructions (if available).
8. **Confirmation**
Please confirm the following before submission:\
\
☐ All required operations and API endpoints have been provided.\
\
☐ API documentation is included.\
\
☐ A test environment is made available to OpenIAM.
## Relational database integration
1. **General information**
| Field | Description | Your response |
| ------------------------- | ------------------------------------------------ | ------------- |
| Company Name | Your organization name | |
| Application Name | The target application to integrate with OpenIAM | |
| Primary Technical Contact | Name, email, and role | |
| Environment(s) | Specify usage: Dev / Test / Prod | |
2. **Database connection details**
| Field | Description | Your response |
| --------------------------- | --------------------------------------- | ------------- |
| Database Type | e.g., Oracle, MSSQL, MySQL, PostgreSQL | |
| JDBC Connection URL | e.g., jdbc:mysql://hostname:3306/dbname | |
| Authentication Type | Username/Password, Windows Auth, etc. | |
| Service Account Credentials | Account used by OpenIAM to connect | |
| Test Environment Access | ☐ Yes
☐ No
| |
3. **User lifecycle operations** (All Required)
| Operation | Table/View/SQL or Procedure | Notes (filters, keys, etc.) |
| --------------------- | --------------------------- | --------------------------- |
| Search Users | | |
| List All Users | | |
| Get User by ID | | |
| Create User | | |
| Update User | | |
| Delete (Soft or Hard) | | |
| Disable/Enable User | | |
4. **Entitlement management** (All Required)
| Operation | Table/View/SQL or Procedure | Notes |
| ----------------------------- | --------------------------- | ----- |
| List Available Roles/Groups | | |
| Assign Role/Group to User | | |
| Remove Role/Group from User | | |
| Get Current User Roles/Groups | | |
5. **Identity attribute mapping & generation rules**
| Attribute Name | Required? | Source Column | Generation Rule (if applicable) | Collision Handling | Notes |
| -------------- | --------- | ------------------------ | ------------------------------- | ----------------------- | -------------------- |
| username | Yes | first\_name + last\_name | firstName.lastName | Append number if exists | Matches AD identity? |
6. **Security constraints**
| Field | Description | Your Response |
| ----------------------- | -------------------------------- | ------------- |
| Firewall / IP Allowlist | Provide steps or OpenIAM IPs | |
| Read/Write Permissions | Tables/views OpenIAM must access | |
| Database Rate Limits | If applicable | |
7. **Attachments checklist**
Please attach or link to the following items:
* ERD (Entity Relationship Diagram) or table descriptions.
* Sample data or schema exports.
* SQL examples for each operation (SELECT, INSERT, UPDATE).
* Test credentials and connection details.
8. **Confirmation**
Please confirm the following before submission:\
\
☐ All required operations and procedures have been documented.\
\
☐ Table/view mappings are included.\
\
☐ A test database is accessible to OpenIAM.
---
# 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/connector-request-template.md?ask=&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.