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.
⚠️ All fields marked as Required must be completed. Incomplete submissions may delay development or require additional follow-up.
REST API Integration
- 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 | |
- API details (Required)
| Field | Description | Your response |
|---|
| Base API URL | e.g., https://api.vendor.com/v1/ | |
| 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 | |
- 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 | |
- User lifecycle operations
| Operation | Endpoint & Method | Notes (required fields, constraints, etc.) |
|---|
| Create User | | |
| Update User | | |
| Delete User | | |
| Disable/Enable User | | |
| Reset Password (if applicable) | | |
- 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 | |
- 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? |
- 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. | |
- 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).
- 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
- 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 | |
- 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 | |
- 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 | | |
- 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 | | |
- 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? |
- 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 | |
- 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.
- 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.