Start & register connector

OpenIAM provides a growing collection of connectors and your deployment will like utilize a subset of these connectors. To use these connectors, they must first be deployed and then register such that they can receive messages from the message bus. The steps for each are described below.

Starting a connector

The steps to start a connector will differ based on whether you are using an RPM deployment or docker. Proceedures for both are provided below


In a Docker deployment the activation of the connector is controlled by the file found in /usr/local/openiam/openiam-docker-compose directory. If you open the file in nano, you will see that following line has been uncommented which means that the ldap connector container will be enabled on startup.

docker stack deploy --compose-file connectors/ldap/docker-compose.yaml --with-registry-auth ldap-connector

To start other connectors, simply uncomment the configuration that is associated with the connector. For example, to deploy the scim connector, uncomment:

docker stack deploy --compose-file connectors/scim/docker-compose.yaml --with-registry-auth scim-connector

You will notice in the docker stack deploy command, we are passing it the docker-compose file related to the connector. The connector yaml files can be found in the /usr/local/openiam/openiam-docker-compose/3.2/connectors/[connector name] director. The yaml files defines an number of paramters to determine how the connector container will operate. These parameters include:

  • Environment variables such as the heap space, Log level,etc
  • Volumes
  • Network
  • Restart policy
  • Health check interval


All the connectors which were part of RPM distribution can be found in the /usr/local/openiam/connectors/bin/ directory. If the connector you are looking for, was not part of the distribution, download it from the OpenIAM website and copy it to the above directory. Ensure that they connector files is own by 'openiam'

chown openiam:openiam [file name]

To start the connector follow use the following type of command systemctl start openiam-connector@[connector_name]

For example to start the SCIM connector the following operation:

systemctl start openiam-connector@scim-connector-rabbitmq

Register the connector

After a connector has been started, it must be registered with OpenIAM so that it can recieve messages that are being sent by the other services in OpenIAM. These messages will tell the connector what to do. Examples of messages include: Find a user, create a user, reset a password, etc.

To register a connector, go to: Webconsole -> Provisioning -> Connectors

You will see a list of connector that have already been registered out of the box. Unless you are working with a custom connector, your connector should already be on this list and there already registered. To configure, click on actions button next to the connector and you will see the screen below.

Connector registration

Make note of the value in the first Connector Queue as you will need to add this to the server side connector configuration as well.

Note: You can replace the queue name value with any unique alpha-numeric word (with no spaces).

Adding the queue name to the connector configuration

To add the queue name of the connector configuration, follow the steps described below.

Docker deployment

RPM deployment