PingOne Advanced Identity Cloud connector
The PingOne Advanced Identity Cloud connector lets you provision and synchronize managed objects between IDM or Advanced Identity Cloud and another Advanced Identity Cloud tenant using the tenant’s Common REST API. The connector supports full CRUD operations, search with server-side filtering, relationship management, and dynamic schema discovery.
The connector uses a single OAuth2-authenticated HTTP client and discovers the tenant’s managed object schema at runtime, so it automatically picks up custom managed objects in addition to the well-known user, role, and organization types.
Advanced Identity Cloud requirements
Before you configure the connector, register an OAuth2 client in your Advanced Identity Cloud tenant and gather the values listed below.
-
In the Advanced Identity Cloud admin console, create a new OAuth2 client (or use an existing service account client) with:
-
Grant type:
Client Credentials -
Scope:
fr:idm:*(full IDM API access)
-
-
Note the following values for the connector configuration:
-
Tenant base URL (for example,
https://openam-mytenant.forgeblocks.com). Must not end with/. -
Realm (for example,
alphaorbravo). If you leave it blank, the connector operates as a generic IDM-to-IDM connector and you must providetokenEndpointexplicitly. -
Client ID
-
Client secret
-
|
When |
Install the PingOne Advanced Identity Cloud connector
|
To check for an Advanced Identity Cloud application for this connector, refer to: |
You can download most connectors from Ping Identity Product Downloads, but some are included in the default deployment for Advanced Identity Cloud, IDM, or RCS. When using an included connector, you can skip installing it and move directly to configuration.
| Connector | IDM | RCS |
|---|---|---|
No |
No |
Download the connector .jar file from Ping Identity Product Downloads.
-
If you’re running the connector locally, place it in the
/path/to/openidm/connectorsdirectory, for example:mv ~/Downloads/aic-connector-1.5.20.39.jar /path/to/openidm/connectors/
-
If you’re using a remote connector server (RCS), place it in the
/path/to/openicf/connectorsdirectory on the RCS.
Configure the PingOne Advanced Identity Cloud connector
To create a connector configuration using a UI, use the Platform admin UI or the legacy admin UI (deprecated). Learn more about creating connector configuration.
Using the Platform admin UI
-
From the sidebar, click Provisioners.
-
On the Provisioners page, click New Provisioner.
-
In the New Provisioner modal, enter a Name.
-
From the Connector Type list, select PingOne Advanced Identity Cloud Connector - 1.5.20.39.
The UI displays a code editor field with the default provisioner configuration for the PingOne Advanced Identity Cloud connector.
-
Make changes to the provisioner configuration, and click Save.
For a list of all configuration properties, refer to PingOne Advanced Identity Cloud Connector Configuration.
When your connector is configured correctly, the connection status on the provisioner page displays as Connected.
Using the legacy admin UI
-
From the navigation bar, click Configure > Connectors.
-
On the Connectors page, click New Connector.
-
On the New Connector page, type a Connector Name.
-
From the Connector Type list, select PingOne Advanced Identity Cloud Connector - 1.5.20.39.
-
Complete the Base Connector Details and any applicable Additional Options.
For a list of all configuration properties, refer to PingOne Advanced Identity Cloud Connector Configuration. -
Click Save.
When your connector is configured correctly, the connector displays as Active in the legacy admin UI.
Connection details
In addition to the standard SaaS common configuration properties, the PingOne Advanced Identity Cloud connector exposes the following:
| Property | Description |
|---|---|
|
Base URL of the Advanced Identity Cloud tenant (for example, |
|
OAuth2 client ID with |
|
OAuth2 client secret. Required. |
|
Advanced Identity Cloud realm name (for example, |
|
OAuth2 token endpoint. Auto-derived from |
|
Number of results returned per CREST page request. Defaults to |
|
HTTP connection timeout in seconds. Defaults to |
|
Maximum HTTP connections in the pool. Defaults to |
|
Accept self-signed SSL certificates. Use only in development or test environments. Defaults to |
|
Disable hostname verification. Use only in development or test environments. Defaults to |
Example PingOne Advanced Identity Cloud configuration
This excerpt shows a sample PingOne Advanced Identity Cloud connector configuration:
{
"configurationProperties" : {
"serviceUri" : "https://openam-mytenant.forgeblocks.com",
"realm" : "alpha",
"clientId" : "your-oauth2-client-id",
"clientSecret" : "your-oauth2-client-secret",
"tokenEndpoint" : null,
"authenticationMethod" : "OAUTH",
"grantType" : "client_credentials",
"scope" : "fr:idm:*",
"authorizationTokenPrefix" : "Bearer",
"useBasicAuthForOauthTokenNeg" : true,
"pageSize" : 1000,
"connectionTimeout" : 30,
"maximumConnections" : 10,
"acceptSelfSignedCertificates" : false,
"disableHostNameVerifier" : false,
"disableHttpCompression" : false,
"clientCertAlias" : null,
"clientCertPassword" : null,
"httpProxyHost" : null,
"httpProxyPort" : null,
"httpProxyUsername" : null,
"httpProxyPassword" : null
}
}
Test the PingOne Advanced Identity Cloud connector
Test that the configuration is correct by running the following command:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request POST \
"http://localhost:8080/openidm/system/aic?_action=test"
{
"name": "aic",
"enabled": true,
"config": "config/provisioner.openicf/aic",
"connectorRef": {
"bundleVersion": "[1.5.0.0,1.6.0.0)",
"bundleName": "org.forgerock.openicf.connectors.aic-connector",
"connectorName": "org.forgerock.openicf.connectors.aic.PingOneAicConnector"
},
"displayName": "PingOne Advanced Identity Cloud Connector",
"objectTypes": [
"__ACCOUNT__",
"__ALL__",
"organization",
"role"
],
"ok": true
}
If the command returns "ok": true, your connector is configured correctly and can authenticate to the Advanced Identity Cloud tenant.
The connector tests connectivity by calling /openidm/info/ping on the tenant.
PingOne Advanced Identity Cloud remote connector
If you want to run this connector outside of PingOne Advanced Identity Cloud or IDM, you can configure the PingOne Advanced Identity Cloud connector as a remote connector. Java Connectors installed remotely on a Java Connector Server function identically to those bundled locally within PingOne Advanced Identity Cloud or installed locally on IDM.
Refer to Remote connectors for configuring the PingOne Advanced Identity Cloud remote connector.
Configure connection pooling
The PingOne Advanced Identity Cloud connector supports HTTP pooling, which can substantially improve the performance of the connector. Learn more about the basic connection pooling configuration and different pooling mechanisms described in Connection pooling configuration.
Implementation specifics
Schema discovery
The connector discovers its schema at runtime from the Advanced Identity Cloud tenant:
-
For each well-known type, the connector reads
/openidm/schema/managed/{realm}_{type}and builds the ICFObjectClassInfofrom the live JSON Schema. -
The connector also queries
/openidm/config/managedand auto-discovers any additionalmanaged/{realm}_*objects, exposing each one as its own ICF object class with generic CRUD operations, search, and relationship handling. -
When
realmis blank, schema and managed-object URLs resolve without a prefix (for example,/openidm/managed/userinstead of/openidm/managed/alpha_user).
Relationship handling
The connector supports three relationship types:
- Array relationships (for example,
roleson a user, ormembers,admins, andownerson an organization) -
-
On create, the connector inlines
_refobjects directly in the POST body so Advanced Identity Cloud creates the object and its relationships in a single request. -
On update, the connector reads the current state, computes the add and remove sets, and emits a single CREST PATCH that combines scalar updates with relationship
addandremoveoperations. -
addAttributeValuesskips the read-current-state step and applies adds directly. -
removeAttributeValuesreads the current state to retrieve the relationship-edge metadata that CREST requires for a remove, but skips the desired-vs-current diff.
-
- Singular relationships (for example,
parenton an organization) -
-
On create, the connector inlines a single
_refobject in the POST body. -
On update, the connector emits a CREST
replace(orremoveif cleared).
-
- Read-only relationships (for example,
effectiveRolesandeffectiveAssignments) -
-
The connector marks these attributes as non-creatable and non-updateable in the schema. IDM and Advanced Identity Cloud filter these attributes before they reach the connector.
-
The connector uses CREST _fields projection to return relationship data in query responses without extra round-trips. Array relationships are projected as {relationship}/_refResourceId. Singular relationships are projected by field name only, because CREST doesn’t support /_refResourceId projection on singular relationships.
Supported search filters
The connector translates ICF filters to CREST _queryFilter syntax. The following filters are supported on any string attribute:
-
equals -
contains -
startsWith -
and/or/notcomposition
endsWith and containsAllValues filters aren’t supported by CREST _queryFilter and result in an UnsupportedOperationException.
HTTP error mapping
The connector maps Advanced Identity Cloud HTTP error responses to ICF exceptions as follows:
| HTTP status | ICF exception |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Use the PingOne Advanced Identity Cloud connector
You can use the PingOne Advanced Identity Cloud connector to perform the following actions on the following PingOne Advanced Identity Cloud resources:
| Connector resource | Advanced Identity Cloud managed object |
|---|---|
|
Users ( |
|
Roles ( |
|
Organizations ( |
(dynamic) |
Any other |
The connector maps __NAME__ to userName for users and to name for roles, organizations, and dynamically discovered objects. For users, it also maps __PASSWORD__ to password and __ENABLE__ to accountStatus (active or inactive).
Users
Create a PingOne Advanced Identity Cloud user
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request POST \
--data '{
"__NAME__": "bjensen",
"__PASSWORD__": "Passw0rd@123!",
"__ENABLE__": true,
"givenName": "Babs",
"sn": "Jensen",
"mail": "bjensen@example.com"
}' \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__?_action=create"
{
"_id": "9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4",
"__NAME__": "bjensen",
"userName": "bjensen",
"givenName": "Babs",
"sn": "Jensen",
"mail": "bjensen@example.com",
"accountStatus": "active"
}
|
When you create a new user, you must specify at least the |
Create a PingOne Advanced Identity Cloud user with role assignments
Inline role assignments in the create request to grant roles atomically:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request POST \
--data '{
"__NAME__": "bjensen",
"__PASSWORD__": "Passw0rd@123!",
"givenName": "Babs",
"sn": "Jensen",
"mail": "bjensen@example.com",
"roles": [
"0bd9c966-7664-4ac1-b059-0ff9293908e2",
"ce00e15f-f845-4df1-abf3-fdc4ff4e176c"
]
}' \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__?_action=create"
Update a PingOne Advanced Identity Cloud user
The connector batches scalar updates and relationship deltas into a single CREST PATCH:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--header "If-Match: *" \
--request PUT \
--data '{
"__NAME__": "bjensen",
"givenName": "Barbara",
"sn": "Jensen",
"mail": "barbara.jensen@example.com",
"__ENABLE__": false
}' \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__/9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
Reset a PingOne Advanced Identity Cloud user password
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--header "If-Match: *" \
--request PATCH \
--data '[{
"operation": "add",
"field": "__PASSWORD__",
"value": "NewPassw0rd!"
}]' \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__/9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
Query all PingOne Advanced Identity Cloud user IDs
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request GET \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__?_queryId=query-all-ids"
{
"result": [
{
"_id": "9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
},
{
"_id": "f4a1c812-bc6b-49a1-9d31-0a8b2c6d3211"
},
...
],
"resultCount": 1000,
"pagedResultsCookie": "",
"totalPagedResultsPolicy": "NONE",
"totalPagedResults": -1,
"remainingPagedResults": -1
}
Read a single PingOne Advanced Identity Cloud user
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request GET \
"http://localhost:8080/openidm/system/aic/__ACCOUNT__/9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
{
"_id": "9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4",
"__NAME__": "bjensen",
"userName": "bjensen",
"givenName": "Babs",
"sn": "Jensen",
"mail": "bjensen@example.com",
"accountStatus": "active",
"roles": [
"0bd9c966-7664-4ac1-b059-0ff9293908e2"
]
}
Delete a PingOne Advanced Identity Cloud user
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match: *" \ --request DELETE \ "http://localhost:8080/openidm/system/aic/__ACCOUNT__/9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
Roles
Create a role
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request POST \
--data '{
"__NAME__": "Sales Manager",
"description": "Grants access to sales reporting"
}' \
"http://localhost:8080/openidm/system/aic/role?_action=create"
{
"_id": "0bd9c966-7664-4ac1-b059-0ff9293908e2",
"__NAME__": "Sales Manager",
"name": "Sales Manager",
"description": "Grants access to sales reporting"
}
|
When you create a new role, you must specify at least the |
Query all role IDs
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/aic/role?_queryId=query-all-ids"
Read a single role
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/aic/role/0bd9c966-7664-4ac1-b059-0ff9293908e2"
Update a role
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--header "If-Match: *" \
--request PUT \
--data '{
"__NAME__": "Sales Manager",
"description": "Updated description"
}' \
"http://localhost:8080/openidm/system/aic/role/0bd9c966-7664-4ac1-b059-0ff9293908e2"
Delete a role
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "If-Match: *" \ --request DELETE \ "http://localhost:8080/openidm/system/aic/role/0bd9c966-7664-4ac1-b059-0ff9293908e2"
Organizations
Create an organization
Inline singular and array relationships in the create request:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--request POST \
--data '{
"__NAME__": "Engineering",
"description": "Engineering organization",
"parent": "8a2f2e7e-1a31-4c45-a311-7c9f2c7b6c41",
"members": [
"9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
],
"admins": [
"f4a1c812-bc6b-49a1-9d31-0a8b2c6d3211"
]
}' \
"http://localhost:8080/openidm/system/aic/organization?_action=create"
{
"_id": "1d6f7c2a-7e3a-4f4d-9b9b-2a8c6e1d3e21",
"__NAME__": "Engineering",
"name": "Engineering",
"description": "Engineering organization",
"parent": "8a2f2e7e-1a31-4c45-a311-7c9f2c7b6c41",
"members": [
"9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4"
],
"admins": [
"f4a1c812-bc6b-49a1-9d31-0a8b2c6d3211"
]
}
|
When you create a new organization, you must specify at least the |
Query all organization IDs
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/aic/organization?_queryId=query-all-ids"
Read a single organization
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request GET \ "http://localhost:8080/openidm/system/aic/organization/1d6f7c2a-7e3a-4f4d-9b9b-2a8c6e1d3e21"
Update an organization (replace the parent and add a member)
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Content-Type: application/json" \
--header "If-Match: *" \
--request PUT \
--data '{
"__NAME__": "Engineering",
"description": "Engineering organization",
"parent": "5f4d3a91-3a4d-4c2a-b6f1-9c7d2a4e8b71",
"members": [
"9b3c70d2-2f7a-4f1f-b3a1-77b6c8d6f2a4",
"a82e1c4f-4d3a-4b1f-8a91-3c2d6e7f9a01"
],
"admins": [
"f4a1c812-bc6b-49a1-9d31-0a8b2c6d3211"
]
}' \
"http://localhost:8080/openidm/system/aic/organization/1d6f7c2a-7e3a-4f4d-9b9b-2a8c6e1d3e21"
Delete an organization
curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "If-Match: *" \ --request DELETE \ "http://localhost:8080/openidm/system/aic/organization/1d6f7c2a-7e3a-4f4d-9b9b-2a8c6e1d3e21"
OpenICF Interfaces Implemented by the PingOne Advanced Identity Cloud Connector
The PingOne Advanced Identity Cloud Connector implements the following OpenICF interfaces. For additional details, see ICF interfaces:
- Create
-
Creates an object and its
uid. - Delete
-
Deletes an object, referenced by its
uid. - Schema
-
Describes the object types, operations, and options that the connector supports.
- Script on Connector
-
Enables an application to run a script in the context of the connector.
Any script that runs on the connector has the following characteristics:
-
The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.
-
The script has access to a
connectorvariable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. -
The script has access to any script arguments passed in by the application.
-
- Search
-
Searches the target resource for all objects that match the specified object class and filter.
- Test
-
Tests the connector configuration.
Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.
This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).
You can invoke the test operation before a connector configuration has been validated.
- Update
-
Updates (modifies or replaces) objects on a target resource.
PingOne Advanced Identity Cloud Connector Configuration
The PingOne Advanced Identity Cloud Connector has the following configurable properties:
Basic Configuration Properties
| Property | Type | Default | Encrypted(1) | Required(2) |
|---|---|---|---|---|
|
|
|
|
Yes |
The service endpoint URI. |
||||
|
|
|
|
No |
The service login name. |
||||
|
|
|
Yes |
No |
The service user password. |
||||
|
|
|
|
Yes |
Defines which method is to be used to authenticate on the remote server. Options are |
||||
|
|
|
|
No |
When using OAUTH as authentication method, this property defines the endpoint where a new access token should be queried for (https://myserver.com/oauth2/token). |
||||
|
|
|
|
No |
The client identifier for OAuth2. |
||||
|
|
|
Yes |
No |
Secure client secret for OAuth2. |
||||
|
|
|
Yes |
No |
Static authentication token. |
||||
|
|
|
|
No |
To be used for debug/test purposes. To be avoided in production. |
||||
|
|
|
|
No |
To be used for debug/test purposes. To be avoided in production. |
||||
|
|
|
|
No |
Set this property to |
||||
|
|
|
|
No |
If TLS Mutual Auth is needed, set this to the certificate alias from the keystore. |
||||
|
|
|
Yes |
No |
If TLS Mutual Auth is needed and the client certificate (private key) password is different from the keystore password, set this to the client private key password. |
||||
|
|
|
|
No |
Defines the max size of the HTTP connection pool used. |
||||
|
|
|
|
No |
Defines the Hostname if an HTTP proxy is used between the connector and the service. |
||||
|
|
|
|
No |
Defines the Port if an HTTP proxy is used between the connector and the service. |
||||
|
|
|
|
No |
Defines Proxy Username if an HTTP proxy is used between the connector and the service. |
||||
|
|
|
Yes |
No |
Defines Proxy Password if an HTTP proxy is used between the connector and the service. |
||||
|
|
|
|
No |
Defines a timeout for the underlying HTTP connection in seconds. |
||||
|
|
|
|
No |
Used by the refresh_token grant type. |
||||
|
|
|
|
No |
The OAuth2 grant type to use ( |
||||
|
|
|
|
No |
The OAuth2 scope to use. |
||||
|
|
|
|
No |
The prefix to be used in the Authorization HTTP header for Token authentication. |
||||
|
|
|
|
No |
The Authentication method for refresh token (Basic Authentication or Sending the ClientId and Client Secret in the Header). |
||||
|
|
|
Yes |
No |
The JWT data structure that represents a cryptographic key. |
||||
|
|
|
|
No |
Defines the JWT expiration time in minutes. |
||||
|
|
|
|
No |
The Algorithm type to sign payload. |
||||
|
|
|
|
No |
JWT Claims to be included in the payload |
||||
|
|
|
Yes |
No |
The contents of the private key of the PEM file |
||||
|
|
|
Yes |
No |
The contents of the certificate of the PEM file |
||||
|
|
|
|
No |
Indicates the type of key (such as RSA, DSA or EC) used to sign from the PEM. |
||||
|
|
|
|
No |
The User Agent HTTP Header used by the connector. Defaults to |
||||
(1) Whether the property value is considered confidential, and is therefore encrypted in IDM.
(2) A list of operations in this column indicates that the property is required for those operations.
Configuration properties
| Property | Type | Default | Encrypted(1) | Required(2) |
|---|---|---|---|---|
|
|
|
|
No |
PingOne AIC realm name (default: alpha) |
||||
|
|
|
|
No |
Number of results per CREST page request (default: 1000) |
||||
(1) Whether the property value is considered confidential, and is therefore encrypted in IDM.
(2) A list of operations in this column indicates that the property is required for those operations.