OpenIDM Integrator's Guide
Preface

Prev | Next

Preface

This guide shows you how to integrate OpenIDM as part of a complete identity management solution.

Contents
Search

loading table of contents...

Preface
- 1. Who Should Use this Guide
- 2. Formatting Conventions
- 3. Accessing Documentation Online
- 4. Joining the Open Identity Platform Community
1. Architectural Overview
- 1.1. OpenIDM Modular Framework
- 1.2. Infrastructure Modules
- 1.3. Core Services
- 1.4. Access Layer
2. Starting and Stopping OpenIDM
- 2.1. To Start and Stop OpenIDM
- 2.2. Specifying the OpenIDM Startup Configuration
- 2.3. Obtaining Information About an OpenIDM Instance
- 2.4. Verifying the Health of an OpenIDM System
- 2.5. Displaying Information About Installed Modules
- 2.6. Starting OpenIDM in Debug Mode
3. OpenIDM Command-Line Interface
- 3.1. configexport
- 3.2. configimport
- 3.3. configureconnector
- 3.4. encrypt
- 3.5. keytool
- 3.6. validate
4. OpenIDM User Interface
- 4.1. Overview of the Default User Interface
- 4.2. Configuring the Default User Interface
- 4.3. Managing User Accounts With the User Interface
- 4.4. Managing Workflows From the User Interface
- 4.5. Changing the UI Theme
- 4.6. Using an External System for Password Reset
- 4.7. Providing a Logout URL to External Applications
- 4.8. Changing the UI Path
- 4.9. Disabling the UI
5. Configuring OpenIDM
- 5.1. OpenIDM Configuration Objects
- 5.2. Changing the Default Configuration
- 5.3. Configuring an OpenIDM System for Production
- 5.4. Configuring OpenIDM Over REST
- 5.5. Using Property Value Substitution in the Configuration
  - 5.5.1. Using Property Value Substitution With System Properties
  - 5.5.2. Limitations of Property Value Substitution
- 5.6. Adding Custom Endpoints
6. Accessing Data Objects
- 6.1. Accessing Data Objects by Using Scripts
- 6.2. Accessing Data Objects by Using the REST API
- 6.3. Defining and Calling Queries
7. Using Policies to Validate Data
- 7.1. Configuring the Default Policy
  - 7.1.1. Policy Script File
    - 7.1.1.1. Policy Configuration Object
    - 7.1.1.2. Policy Implementation Function
  - 7.1.2. Policy Configuration File
- 7.2. Extending the Policy Service
- 7.3. Disabling Policy Enforcement
- 7.4. Managing Policies Over REST
  - 7.4.1. Listing the Defined Policies
  - 7.4.2. Validating Objects and Properties Over REST
8. Configuring Server Logs
9. Connecting to External Resources
- 9.1. About OpenIDM & OpenICF
- 9.2. Accessing Remote Connectors
- 9.3. Configuring Connectors
- 9.4. Connector Configuration Examples
- 9.5. Creating Default Connector Configurations
10. Configuring Synchronization
- 10.1. Types of Synchronization
- 10.2. Managing Reconciliation Over REST
- 10.3. Triggering LiveSync Over REST
- 10.4. Flexible Data Model
- 10.5. Basic Data Flow Configuration
- 10.6. Synchronization Situations and Actions
- 10.7. Asynchronous Reconciliation
- 10.8. Configuring Case Sensitivity for Data Stores
- 10.9. Reconciliation Optimization
- 10.10. Correlation Queries
  - 10.10.1. Managed Object as Correlation Query Target
  - 10.10.2. System Object as Correlation Query Target
- 10.11. Advanced Data Flow Configuration
- 10.12. Scheduling Synchronization
  - 10.12.1. Configuring Scheduled Synchronization
  - 10.12.2. Alternative Mappings
11. Scheduling Tasks and Events
- 11.1. Scheduler Configuration
- 11.2. Configuring Persistent Schedules
- 11.3. Schedule Examples
- 11.4. Service Implementer Notes
- 11.5. Scanning Data to Trigger Tasks
  - 11.5.1. Configuring the Task Scanner
  - 11.5.2. Managing Scanning Tasks Over REST
12. Managing Passwords
- 12.1. Enforcing Password Policy
- 12.2. Password Synchronization
13. Managing Authentication, Authorization and RBAC
- 13.1. OpenIDM Users
  - 13.1.1. Internal Users
  - 13.1.2. Managed Users
- 13.2. Authentication
- 13.3. Roles
- 13.4. Authorization
14. Securing & Hardening OpenIDM
- 14.1. Use SSL and HTTPS
- 14.2. Restrict REST Access to the HTTPS Port
- 14.3. Encrypt Data Internally & Externally
- 14.4. Use Message Level Security
- 14.5. Replace Default Security Settings
- 14.6. Secure Jetty
- 14.7. Protect Sensitive REST Interface URLs
- 14.8. Protect Sensitive Files & Directories
- 14.9. Obfuscate Bootstrap Information
- 14.10. Remove or Protect Development & Debug Tools
- 14.11. Protect the OpenIDM Repository
- 14.12. Adjust Log Levels
- 14.13. Set Up Restart At System Boot
15. Integrating Business Processes and Workflows
- 15.1. BPMN 2.0 and the Activiti Tools
- 15.2. Setting Up Activiti Integration With OpenIDM
- 15.3. Managing Workflows Over the REST Interface
- 15.4. Example Activiti Workflows With OpenIDM
  - 15.4.1. Example Email Notification Workflow
  - 15.4.2. Sample Workflow - Provisioning User Accounts
    - 15.4.2.1. Overview of the Sample
    - 15.4.2.2. Running the Sample
16. Using Audit Logs
- 16.1. Audit Log Types
- 16.2. Audit Log File Formats
- 16.3. Audit Configuration
- 16.4. Generating Reports
17. Sending Email
- 17.1. Sending Mail Over REST
- 17.2. Sending Mail From a Script
18. OpenIDM Project Best Practices
- 18.1. Implementation Phases
19. Troubleshooting
- 19.1. OpenIDM Stopped in Background
- 19.2. Internal Server Error During Reconciliation or Synchronization
- 19.3. The scr list Command Shows Sync Service As Unsatisfied
- 19.4. JSON Parsing Error
- 19.5. System Not Available
- 19.6. Bad Connector Host Reference in Provisioner Configuration
- 19.7. Missing Name Attribute
File Layout
Ports Used
Data Models and Objects Reference
- 1. Managed Objects
- 2. Configuration Objects
- 3. System Objects
- 4. Audit Objects
- 5. Links
Synchronization Reference
- 1. Object-Mapping Objects
  - 1.1. Property Objects
  - 1.2. Policy Objects
    - 1.2.1. Script Object
- 2. Links
- 3. Queries
- 4. Reconciliation
- 5. REST API
REST API Reference
- 1. URI Scheme
- 2. Object Identifiers
- 3. Content Negotiation
- 4. Conditional Operations
- 5. Supported Methods
Scripting Reference
- 1. Scripting Configuration
- 2. Examples
- 3. Function Reference
- 4. Places to Trigger Scripts
- 5. Variables Available in Scripts
- 6. Debugging OpenIDM Scripts
Router Service Reference
- 1. Configuration
- 2. Example
Embedded Jetty Configuration
- 1. Using OpenIDM Configuration Properties in the Jetty Configuration
  - 1.1. Accessing Explicit Bean Properties
  - 1.2. Accessing Generic Properties
- 2. Jetty Default Settings
- 3. Registering Additional Servlet Filters
Release Levels & Interface Stability
- 1. Open Identity Platform Product Release Levels
- 2. Open Identity Platform Product Interface Stability
OpenIDM Glossary
Index

Search Highlighter (On/Off)