As indicated in other sections, before you can use a connector you must ensure that it has been:

• deployed;
• started;
• registered.

These three prerequisite steps must be performed before attempting to use any of the connectors. This section describes how you can perform these steps in a Docker environment.

Deploying a connector

To deploy a connector in terraform, the changes need to be made for terraform.tfvars file.

1. Find the 'connectors' section in terraform.tfvars file.
2. Enable the required connector as shown below.

replica_count_map = {
...

    connectors = {
        ldap = 1
        google = 0
        aws = 0
        freshdesk = 0
        linux = 1
        oracle_ebs = 0
        oracle = 0
        scim = 1
        script = 1
        salesforce = 0
        rexx = 0
        jdbc = 1
        saps4hana = 0
        freshservice = 0
        tableau = 0
        oracle_idcs = 0
        workday = 0
        adp = 0
        ipa = 0
        box = 0
        boomi = 0
        lastpass = 0
        kronos = 0
        thales = 0
        postgresql = 0
    }

3. Run the following command

terraform apply

Connector is deployed.

Registering the connector

After a connector has been started, it must be registered with OpenIAM so that it can receive 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.

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

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

Make note of the value in the Connector Queue. The out-of-the-box connectors already have predefined queue names. If it's a custom connector, then you will need to provide this value.