How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I find the available parameters for inclusion in the provisioner configuration file for a connector in IDM (All versions)?

Last updated Apr 8, 2021

The purpose of this article is to provide information on finding the available parameters for inclusion in the provisioner configuration file for a connector in IDM. This information applies to all connectors (Adobe Marketing Cloud Connector, CSV File Connector, Database Table Connector, Google Apps Connector, Groovy Connector, HubSpot Connector, Kerberos Connector, LDAP Connector, Marketo Connector, PowerShell Connector, Salesforce Connector, SAP Connector, SCIM Connector, Scripted REST Connector, Scripted SQL Connector, ServiceNow Connector, SSH Connector and Workday Connector).


Finding available parameters

You can use a curl command that includes the connectorHostRef parameter in the createCoreConfig action to return all the available parameters that can be included in the provisioner configuration file for a connector. The connectorHostRef parameter must be set as described in the Connectors Guide.

For example, for a remote Powershell connector named dotnet, the curl command would look like this:

  • IDM 7 and later: $ curl -X POST -H "X-OpenIDM-Username: openidm-admin" -H "X-OpenIDM-Password: openidm-admin" -H "Accept-API-Version: resource=1.0" -H "Content-Type: application/json" -d '{"connectorRef" {"connectorName":"Org.ForgeRock.OpenICF.Connectors.MsPowerShell.MsPowerShellConnector", "displayName":"Scripted PS Connector", "bundleName":"MsPowerShell.Connector", "connectorHostRef" : "dotnet", "bundleVersion":"1.4.6.0"} }' "https://localhost:8080/openidm/system?_action=createCoreConfig&_prettyPrint=true”
  • Pre-IDM 7: $ curl -X POST -H "X-OpenIDM-Username: openidm-admin" -H "X-OpenIDM-Password: openidm-admin" -H "Content-Type: application/json" -d '{"connectorRef" {"connectorName":"Org.ForgeRock.OpenICF.Connectors.MsPowerShell.MsPowerShellConnector", "displayName":"Scripted PS Connector", "bundleName":"MsPowerShell.Connector", "connectorHostRef" : "dotnet", "bundleVersion":"1.4.6.0"} }' "https://localhost:8080/openidm/system?_action=createCoreConfig&_prettyPrint=true”

See Also

FAQ: Connectors in IDM

Empty path name is not legal error with the PowerShell connector in IDM (All versions)

Empty path name is not legal error with the Groovy connector in IDM (All versions)

Connectors Guide › Configure Connectors

Connectors Guide › Creating Connector Configurations Over REST

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.