ADP connector
This page describes how to enable provisioning to manage ADP HR system users.
The ADP connector is used to connect to ADP human resources information systems (HRIS). It integrates OpenIAM with ADP to synchronize users and their status, authenticating with OAuth2 client credentials and a client SSL certificate.
Search / synchronize users
✅
Test connection
✅
Create/update, delete, suspend/resume, reset password
❌ Not supported — ADP is the authoritative HR source; OpenIAM reads from it
Group provisioning
❌ Not supported
Use cases
Using ADP as the authoritative HR source: importing workers into OpenIAM to drive the joiner/mover/leaver lifecycle downstream.
Keeping user status in OpenIAM aligned with ADP (active, leave, terminated).
Not a provisioning target — OpenIAM does not write to ADP.
Versions and compatibility
The end application is ADP, reached through ADP's own Marketplace connection library rather than by building REST calls directly. Authentication is OAuth 2.0 against ADP's token endpoint, and worker data comes from the ADP HR API v2.
Platform
ADP
Interface
ADP Marketplace Java library over HTTPS
Authentication
OAuth 2.0, /auth/oauth/v2/token, with a client certificate
Workers
/hr/v2/workers
Prerequisites
An ADP API integration: Client ID and Client Secret from the ADP side (see the ADP documentation center).
The SSL certificate generated by your ADP administrator for API access, placed on the server where the ADP connector runs, together with its key and store passwords.
Network access from the connector host to your ADP instance (HTTPS).
Installing the connector
Kubernetes
In Kubernetes deployments, the connector is deployed as part of OpenIAM — enable it in your deployment configuration; no separate installation is required.
RPM
Run the connector JAR directly, or use the connector service unit (openiam-connector@adp-connector-rabbitmq). To deploy on a separate host, see Connectors via RPM.
Starting, stopping, and restarting
RPM (systemd)
systemctl start|stop|restart openiam-connector@adp-connector-rabbitmq
Kubernetes
kubectl rollout restart the connector deployment.
Command-line parameters and properties
The connector is a Spring Boot application. Its defaults ship inside the jar, and you override them in either of two places:
An external property file, read at
${confpath}/conf/properties/adp-connector-rabbitmq.properties. The file is optional, andconfpathis itself a system property, set with-Dconfpath=/data/openiam/.Directly on the command line, as
-Darguments, which win over the file.
org.openiam.connector.queue
ADP_Connector_1_Request
org.openiam.connector.name
ADP
org.openiam.adp.date.format
yyyy-MM-dd
Date format used when reading and writing ADP worker records
The connection details themselves are not set here — they are managed system parameters, covered under Configuring the managed system.
Verifying the connector is running
In the Webconsole, open the managed system — the Running connector status indicator must be green.
Click Test Connection — it must return success.
In the RabbitMQ management console, confirm the ADP_Connector_1_Request queue exists and has a consumer.
Check the connector log for startup errors.
Troubleshooting
Test connection fails
Wrong token endpoint, Client ID/Secret, or certificate settings
Re-verify each managed-system field; confirm the SSL cert path is valid on the connector host and the key/store passwords match.
Connection drops periodically
Token expiry handling
Expected behavior — the connector re-requests the token near expiry; investigate only if syncs actually fail.
Sync returns no users
Query filter too narrow or malformed
Start with *, then add status filters incrementally.
Attempts to provision to ADP do nothing
ADP is a read-only source
Expected — see the operations table above.
A provisioning request to ADP reports success
Every write operation is a stub
Create, update, delete, suspend, resume, password reset and group create/delete each return SUCCESS without calling ADP. OpenIAM records the operation as done; ADP is unchanged. Read from ADP and write elsewhere.
See also: general connector troubleshooting and the connector error-code reference.
Registering the connector in OpenIAM
The connector ships pre-registered; if you register it manually under Provisioning → Connectors, the queue name must match exactly:
Configuring the managed system
OpenIAM ships a default managed system called ADP Managed System. Log in to the Webconsole, go to Provisioning → Managed system, find it, and click Edit. Key fields:
Token endpoint
The URL of the ADP instance. OpenIAM hits different endpoints against it: TOKEN (POST /auth/oauth/v2/token), USERS (GET /hr/v2/workers), single USER (GET /hr/v2/workers%s).
Client ID
Copied from the ADP HRIS system (see the ADP documentation center).
Client Secret
Copied from the ADP HRIS system.
SSL cert
Path to the SSL certificate. It must be on the same server where the ADP connector runs.
Key password
Provided when the ADP administrator generates the SSL certificate.
Store password
Provided when the ADP administrator generates the SSL certificate.
Click Save.
Token lifecycle
OpenIAM requests an authorization token from ADP. The token has its own lifecycle; when it expires, OpenIAM requests a new one. Because OpenIAM's IDM service tests the connection every minute, the connector treats the connection as live until the token is close to expiry (for example, with a 30-minute token, a new one is requested around minute 29) — this avoids overloading the ADP service.
Attribute mapping and policy map
No outbound policy map is needed (the connector is read-only). Inbound mapping is done by the synchronization transformation script, which can transform all the user data stored in the HR system — names, phone numbers, emails, addresses, employment data, and user status. The fields the connector can fetch:
Reconciliation and synchronization
Synchronization is the connector's purpose. OpenIAM ships a default configuration named ADP User Example:
Log in to the Webconsole and go to Provisioning → Synchronization.
Find the ADP User Example configuration and click Edit. The fields are pre-filled to synchronize Employee ID and Worker ID, with a pre-selected transformation script.
Set the search query:
*— all users.*statuses: ACTIVE, LEAVE, etc. — filter by status; the ADP status filter("workers/workerStatus/statusCode/codeValue eq '%s'")is applied.A query starting with
/searches a single user (the/hr/v2/workers%sfilter is applied).Combine criteria with
&.
Last updated
Was this helpful?