The Active Directory (AD) module in Qntrl Bridge allows you to integrate with Microsoft Active Directory to manage users, computers, and groups within your organization securely.
AD is a directory service developed by Microsoft to centrally manage network resources such as users, computers, and applications. These entities are stored as Objects, which are organized under Organizational Units (OU) within one or more domains.
Prerequisite

This allows greater flexibility in managing directory entries, attributes, and relationships directly from your automated workflows.
Sample LDIF Script:
dn:%q_dn%
changeType: modify
replace: mail
mail: %q_mail_id%

Keys | Description |
task_details | A JSON object that contains details of the task. |
ad_host | Location of the AD. |
ad_dn | Distinguished Name of AD. |
activity_name | Name of the activity performed in AD. When executing an LDIF script, specify this value as file. |
task_name | A system-defined name for the respective modules. 'ad_task' is the task name for Active Directory. |
credential | A JSON object that contains the name of the AD server credential. |
name | Name of the AD server credential. |
object_name | Name of the object. |
object_type | Type of the object. |
organization_unit | Name of the OU. |
properties | A JSON object that contains additional information related to the user. |
objectClass | Category/type of the object. |
givenName | Display name of the user. |
user_name | Login name of the user in AD. |
password | Password of the user. |
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN>","activity_name": "file","script_name": "<SCRIPT_NAME>","variable": {"<KEY>": "<VALUE>","<KEY>": "<VALUE>"}},"credential": {"name": "<CREDENTIAL_NAME>"}}
Add AD User
To add a new user to the Active Directory in a private network.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "create_object","object_name": "<OBJECT_NAME>","organization_unit": "<ORGANIZATION_UNIT_NAME>","object_type": "user","properties": {"ObjectClass": "user","givenName": "<DISPLAY NAME OF THE USER>"}},"credential": {"name": "<CREDENTIAL_NAME>"}}
To add a new computer to the Active Directory of the client's network.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "create_object","object_name": "<OBJECT_NAME>","organization_unit": "<ORGANIZATION_UNIT_NAME>","object_type": "computer","properties": {"ObjectClass": "computer","givenName": "<DISPLAY NAME OF THE OBJECT>"}},"credential": {"name": "<CREDENTIAL_NAME>"}}
To add a new group to the Active Directory of the client's network.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "create_object","object_name": "<OBJECT_NAME>","organization_unit": "<ORGANIZATION_UNIT_NAME>","object_type": "group","properties": {"ObjectClass": "group","givenName": "<DISPLAY NAME OF THE GROUP>"}},"credential": {"name": "<CREDENTIAL_NAME>"}}
To add a user under a group in the Active Directory of the client's network.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "create_object","object_name": "<OBJECT_NAME>","organization_unit": "<ORGANIZATION_UNIT_NAME>","object_type": "group","properties": {"ObjectClass": "group","givenName": "<DISPLAY NAME OF THE GROUP>"}},"credential": {"name": "<CREDENTIAL_NAME>"}}
To disable an existing user in the Active Directory.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "disable_user","user_name": "<USER_NAME>"},"credential": {"name": "<CREDENTIAL_NAME>"}}
To enable a disabled user in the Active Directory.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "enable_user","user_name": "<USER_NAME>"},"credential": {"name": "<CREDENTIAL_NAME>"}}
To unlock the user, who has been locked due to multiple incorrect password entries.
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "unlock_account","user_name": "<USER_NAME>"},credential": {"name": "<CREDENTIAL_NAME>"}}
Request data
{"task_name": "ad_task","task_details": {"ad_host": "<HOST_NAME>","ad_dn": "<DN OF THE AD MACHINE>","activity_name": "reset_password","user_name": "<USER_NAME>","password": "<PASSWORD>","is_unlock_account": true,"is_user_reset_password_next_logon": true},"credential": {"name": "<CREDENTIAL_NAME>"}}
is_unlock_account - If the user account is locked, whether to unlock it while resetting the password.
true - to unlock the account
false - to not unlock the account
is_user_reset_password_next_logon - After resetting the password, whether to make it mandatory for the user to reset the password during his next login.
true - password has to be reset during the next logon
false - not necessary to reset the password again during the next logon
Recheck the User DN and Password provided while creating the AD credential in Qntrl.
Make sure the AD user account has the required permissions to perform create, modify, or delete operations.
If credentials were updated or reset recently in AD, update them in Qntrl as well.
Ensure that your script follows the LDIF format and uses variables in the format %q_<variable_name>%.
When referencing variables in Bridge payloads or Circuit variables, omit the %q_% prefix and use only the snake_case variable name.
Example: In script → %q_mail_id% , In payload → mail_id
Confirm that the LDIF task being executed supports the operation. (Read/filter operations are not supported via LDIF scripts.)
Open Bridge Agent >> Core Service >> Logs to view real-time execution details.
Download the log file for deeper analysis using Bridge Agent → Logs → Download Log File.
You can also access logs locally from Bridge/logs/
You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.