The AD task is used to connect to the Active Directory of the client's network and perform AD operations securely there. 

There are eleven states in AD Task,

1. Add AD User
2. Add AD Group
3. Add User to Group
4. Add AD Computer
5. Enable AD User
6. Disable AD User
7. Reset AD Password
8. Unlock AD User
   

Prerequisite

• An active Bridge agent. Refer here to install and configure Bridge.

• Create the necessary Credentials for the applications to be connected by Active Directory.

For more details about the Active Directory module in Bridge, the keys, and its description, click here.

For all the AD states follow the below procedure to configure in the Builder View:

Builder View

1. In Builder View, drag and drop the required AD state from the left pane into your Circuit or click the required state in your Circuit.

2. Under Configuration, update the common state field attributes. 

3. Bridge ID field should capture the details of the Bridge to be used for this task. Click and select the Bridge to be configured from the drop-down list.  

4. Under the Add Configuration section, fill in the following fields:

• Credential ID - Click and select the credential from the dropdown list. The Credential ID of all the credentials created for the AD module type will be displayed in the list.

• AD Host - Enter the hostname of the machine in which the Active Directory is located. Enter the hostname as localhost, if the Active Directory is located on the same Bridge-installed machine.

• AD DN - Distinguished name of the AD.

5. Under the Properties section, click Add, and enter the user attributes that has to be added to the AD. To remove a user attribute added to the Properties, hover over the line below the properties fields and click Remove.
   

6. In the Error Handling section, you can select and configure error handling settings. For additional details, refer to the Error Handling in Circuit States.

7. In Input/Output, enter the required paths. To learn more about I/O paths, click here. 
   

1. Add AD User

In Builder View, under the Add Configuration section, in the Organization Unit field, enter the name of the Organization Unit in which the user has to be added, and in the Object Name field, enter the name of the user to be added to the AD.

 

Equivalent JSON in Code View to add users to the Active Directory is given below:

"Add User in AD": {
      "type": "add_ad_user",
      "next": "Update Onboarding Ticket Status",
      "bridge_id": "bridge-employee onboarding",
      "payload": {
            "credential_id": "ad_credentials_3",
            "ad_host": "localhost",
            "ad_dn": "DC=com,DC=qntrl",
            "organization_unit": "Finance",
            "object_name": "john.mathew",
            "properties": {
 		"givenName": "John Mathew",
 		"mail": "john.mathew@zylker.com"
           }
      }
}

2. Add AD Group   

Add a Group in AD": {
      "type": "add_ad_group",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "credential_id": "<credential_name>",
            "ad_host": "host_name>",
            "ad_dn": "<DN of the AD machine>",
            "organization_unit": "<name of organization unit>",
            "object_name": "<name of organization>",
            "properties": {
                  "ObjectClass": "computer",
                  "givenName": "Windows11"
            }
      }
}

3. Add User to Group  

With this state, a user can be added to an existing group of the Active Directory in the client's network or machine.

In Builder View, under the Add Configuration section, enter the User Name, the name of the user to be added to the group, and Group Name, the group name to which the user has to be added.
  

The JSON to add a user to a group in an Active Directory in Code View is given below:

"Add an User to AD Group": {
      "type": "add_ad_user_to_ad_group",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "credential_id": "<credential_name>",
            "ad_host": "<host_name>",
            "ad_dn": "<DN of AD machine>",
            "user_name": "<user_name>",
            "group_name": "<AD group_name>"
      }
}

4. Add AD Computer  

"Add a Computer in AD": {
      "type": "add_ad_computer",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
	  "credential_id": "<credential_name>",
	  "ad_host": "<host IP of AD machine>",
	  "ad_dn": "<DN of AD machine>",
	  "organization_unit": "<name of organization unit>",
	  "object_name": "<name of object>",
	  "properties": {
	   	"ObjectClass": "computer",
               	"givenName": "Windows11"
 	  }
      }
}

"Enable an User in AD": {
      "type": "enable_ad_user",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "credential_id": "<credential_name>",
            "ad_host": "<host IP of AD machine>",
            "ad_dn": "<DN of AD machine>",
            "user_name": "<user_name>"
      }
}

6. Disable AD User   

In Builder View, enter the name of the user in the User Name field, who needs to be disabled.

"Disable an User in AD": {
      "type": "disable_ad_user",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
      "payload": {
            "credential_id": "<credential_name>",
            "ad_host": "<host IP of AD machine>",
            "ad_dn": "<DN of AD machine>",
            "user_name": "<user_name>"
      }
}

7. Reset AD Password     

This state helps you reset the password if the password has been forgotten or needs to be reset.

In Builder View, under the Add Configuration section, fill in the following details:

• User Name - Name of the user, whose password needs to be reset.

• Password - Current password of the user.

• Unlock account - If the user account is locked, whether to unlock it while resetting the password.

• True - to unlock the account.

• False - not to unlock the account
  

• Force Password Change - 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 
  

The JSON equivalent in Code View to add an AD computer is given below:

"Reset User Password": {
      "type": "reset_ad_password",
      "next": "End",
      "start": true,
      "bridge_id": "bridge-employee onboarding",
      "payload": {
            "credential_id": "ad_credentials_3",
            "ad_host": "localhost",
            "unlock_account": true,
            "force_password_change": false,
            "ad_dn": "DC=com,DC=qntrl",
            "password": "123***",
            "user_name": "John"
      }
}

"Unlock an User in AD": {
      "type": "unlock_ad_user",
      "next": "End",
      "start": true,
      "bridge_id": "<bridge_name>",
            "payload": {
            "credential_id": "<credential_name>",
            "ad_host": "<host IP of AD machine>",
            "ad_dn": "<DN of AD machine>",
            "user_name": "<user_name>"
      }
}