AD Kit Installation

Dataedo AD Kit

Dataedo AD Kit is a tool that can synchronize your Active Directory groups and users with Dataedo Portal groups and users.

In short Dataedo AD Kit reads configuration from the config file and based on it read users from the Active Directory and saves them to the Dataedo Portal.

Running AD Kit

Download the latest ADKit.exe from our download page.

Enabling API Connection in Dataedo Portal

Firstly you need to enable API connection in Dataedo Portal System Settings. You will have to paste the token into the configuration file. It will be used by AD Kit to create, update and delete users in Dataedo Portal.

Configuration file

Create a new ADKit.conf file in the same directory as ADKit.exe. Copy and paste the content below.

[LDAP]
HOST = 192.168.0.1
PORT = 389
# DOMAIN = Dataedo
# You can use domain parameter alternatively to the HOST & PORT
# CONTAINER = OU
# You can specify a container in Active Directory to limit the AD scope
USERNAME = Dataedo\AD
PASSWORD = P@ssw0rd

[API]
TOKEN = eyJhbGciO...iJIUzI1
URL = https://your-web-catalog-domain.com:6000
# URL = http://localhost:8081/api/
# For localhost provide the address with a port and directory when needed
# You can find your API host in the page source in the Dataedo Web\Applications\UI

[SETTINGS]
AD_DISPLAY_NAME = displayName
# Name of the field in the Active Directory, which should be synced with the Dataedo Portal display name

AD_EMAIL = mail
# Name of the field in the Active Directory, which should be synced with the Dataedo Portal email

AD_GROUP = WebCatalog
# Name of the group in the Active Directory, which should be synced with the Dataedo Portal (source group)

WEB_GROUP = DataSteward
# Name of the group in the Dataedo Portal, to which users should be synced (target group)

# You can synchronize multiple Active Directory groups. To do that, add suffix "_<NUMBER>" to each AD_GROUP, WEB_GROUP pair:
#   AD_GROUP_1 = WebCatalog
#   WEB_GROUP_1 = DataSteward
#   AD_GROUP_2 = WebView
#   WEB_GROUP_2 = DataViewer

CREATE_USERS = True
# CREATE_USERS = True - create new users
# CREATE_USERS = False - only assign groups to existing users

DELETE_USERS = True
# DELETE_USERS = True - delete users who are deleted from the group. If multiple groups are synchronized, users who are not in any AD_GROUP and were removed from at least one WEB_GROUP are deleted from Dataedo Portal
# DELETE_USERS = False - only remove users from groups but leave them in the Dataedo Portal

Running ADKit.exe

Open PowerShell and change the directory to the one with ADKit.exe and ADKit.conf. Then simply execute the .exe file.

There are a few arguments you can pass to the execution:

Constant sync

If you would like to constantly sync Active Directory with Dataedo Web Catalog, schedule the execution of ADKit.exe in Windows Scheduler to run for instance every hour.

Common problems