AD task state in Circuit | Qntrl | Circuit | Online Help

AD task

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.


Example Use Case: As part of the employee onboarding process, it is necessary to provision recruited employees within the organization. This provisioning includes tasks such as adding the employee to the organization's Active Directory and placing them into relevant teams. To streamline these tasks, the AD task can be utilized to handle employee provisioning within Active Directory.

Let us see how to configure the AD task in Builder View and Code View.

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

This state is used to add a new user to the Active Directory of the client's network.

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",
           }
      }
}

2. Add AD Group   

By configuring this state in circuit, you can add a group to the Active Directory of the client's network.

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

The JSON to configure an Active Directory in Code View is given below:
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  

This state is used to add a computer device to the Active Directory of a private network. 
  

In Builder View, under the Properties section, click Add, and enter the computer attributes that has to be added to the AD. To remove a computer attribute added to the properties, hover over the line below the properties fields and click Remove.

 

The JSON equivalent in Code View to add an AD computer is given below:
"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"
  }
      }
}

5. Enable AD User   

If an already existing user in Active Directory is disabled for any reason, you can enable the user with this state.
In Builder View, enter the name of the user in the User Name field, who needs to be enabled.
  
The JSON equivalent in Code View to enable a user in AD is given below:
"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   

This state is used to disable an existing user in the AD.

  

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

 

The JSON equivalent in Code View to disable a user in AD is given below:
"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"
      }
}

8. Unlock AD User   

If a user has been locked due to multiple incorrect password entries, this state allows the user to be unlocked.
In Builder View, the state can be configured by giving the name of the user, who needs to be unlocked in the User Name field.
  
The JSON equivalent in Code View to unlock AD user is given below:
"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>"
      }
}





Next: Files state


    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Active Directory(AD)

                                                                                                                Active Directory(AD) is a service developed by Microsoft that provides a centralized way to manage all your network machines, users, and resources in one place. Active Directory stores data as Objects, which include users, groups, applications, and ...
                                                                                                              • Task Engine

                                                                                                                In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in bridge ...
                                                                                                              • Task Engine

                                                                                                                Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...
                                                                                                              • Zoho Directory in Qntrl

                                                                                                                What is Active Directory?  Active Directory (AD) by Microsoft is a domain management system for centralized networks. Using AD, you can add users, define their privilege, store and manage information, and authorize and authenticate user accounts.  ...
                                                                                                              • Introduction to States of Circuit

                                                                                                                States are the building blocks of a circuit that can perform tasks, make decisions, or simply pass the output from one state to another. The state defines a specific task or process that has to be executed in that segment of the circuit. Circuit ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources