Connecting ADC to IDMAPI (Configuration)
Connecting the on-premises Eko Active Directory Connector (EkoADC) to the Eko Identity Management API (EkoIDMAPI) is a required step to enable both user synchronization and authentication. This configuration links the two main components using shared tokens and network endpoints.
The configuration involves two main areas: setting up the domain rules on the Eko side (IDMAPI Admin Panel) and configuring the communication endpoints on the customer side (EkoADC Console).
1. IDMAPI Configuration
Amity Solutions' team primarily manages configuration in the Eko Identity Management API (EkoIDMAPI), but the customer must understand the settings as they define the communication path back to the EkoADC. This configuration is done via the IDMAPI Admin Panel.
The key configurations required for the ADC to connect to IDMAPI are set under the Config tab for the specific domain:
AD Domain
This value specifies the domain name used for synchronization.
Secret Token
A shared key used to connect ADC to IDM. This token is required to secure API communication between the two components.
Webhook URL
The HTTPS endpoint on the EkoADC server where EkoIDMAPI (or Eko Backend) sends authentication requests and other webhooks.
Additionally, the IDMAPI Admin Panel is where Domain Priorities are set (if enabled). Setting priority points for AD domains is crucial for resolving conflicts when duplicated users exist across multiple source domains.
2. ADC Console Configuration
Note that in the majority of cases, the EkoADC Console and configurations are managed by the Eko Team.
Once the EkoADC container is running and accessible via its web console (using HTTPS protocol), the customer needs to configure the connection details to the Eko services.
Access the Console Menu: Access the ADC Admin Panel (EkoADC web console).
Navigate to IDMAPI Tab: In the console menu, navigate to the IDMAPI tab.
Specify Connection Details: Within this tab, you must specify the following configurations:
IDMAPI Endpoint: The specific URL endpoint for the EkoIDMAPI.
ad_domainValue: The corresponding ad_domain value. This value must exactly match thead_domainvalue defined in the EkoIDMAPI configuration for this connection.secret_token: This token must match the value provided by the Eko team and configured in the IDMAPI Admin Panel.
Once both sides are configured and the matching secret_token is exchanged, the EkoADC can securely send synchronization data to the IDMAPI and receive authentication requests.
The connection to IDM or AD can be tested using the Test menu on the ADC Admin Panel.
Last updated