The Find Users remote procedure allows you to look for a user within your directory by defining a user attribute as a means of searching for them.
When to use
Having an AD connector will allow you to access information that is stored within your Kianda subscription. You will be able to use User related AD functions which will allow you to use the connector when manipulating users within your AD. For example creating users, updating their permissions, moving them between groups or removing them from the directory. To use the AD functions, you can use the Data rules that are predefined within Kianda.
Before you get started
Create a data connector to your AD database by following the steps detailed in the Active Directory data connector page .
Remote procedure inputs
From the Kianda home page, click on Administration > Data sources.
Click on + Add new button and choose Active Directory from the list of data sources provided.
You will be automatically brought to the Active Directory details page, where you can start setting up the connection.
Choose from the edit options:
- Display name - type in the name for your PowerShell connector. The display name is used to identify your connector.
- Directory path - enter in the path to the directory. The path must be LDAP or GC.
- AD User - enter in the domain and user that you want to connect to. To specify the domain and user correctly use the following format:
- Password - enter in the password used to login for the desired user.
- Use Kianda Cloud Connect - by default this option is enabled, the cloud connect is used to create a connection between the Active Directory connector and Kianda itself. To learn more about Kianda Cloud Connect and how to create a connection between Kianda and your PC, go to Kianda Cloud Connect.
- Connectors - displays all available connector PC’s that have a connection established with your Kianda subscription. This option is used to select the PC connection that is running the Active Directory server.
- Status - represents the current status of the connection.
- incomplete - means that the details of the connector were not fully completed.
- test failed - means that the details of the connector are incorrect and the connection has failed.
- ready - means that the connector has successfully connected and its ready to be used.
When you have added PowerShell details, you are ready to test your connection and add security. At the bottom of the PowerShell Connector page, click on Test connection button and if the service has been correctly configured, then you should receive a notification saying Connection test succeeded.
Click on Save to save the connection and you will receive a notification saying Details saved successfully.
Add Security settings by clicking on the Security button, go to Setting security for data sources for more details.
Click on Close to close the details page and return to the data source management main view.
Active Directory functions
Active Directory functions are Users related and to use them you have to use the Data rules that are predefined within Kianda. The functions that are available are:
- FindUsers - allows you to look for a user within your directory by defining a user attribute as a means of searching for them.
- IsMemberOf - allows you to see if a user is a member of a group. You need to specify both a user and a group.
- CreateUser - allows you to create a user within your directory. You need to specify a username, first name, last name, email and password to create a user successfully.
- UpdateUser - allows you to update user attributes. You need to specify what user to update by providing their sAMAccountName and distinguishedName (DN).
- AddUserToGroup - allows you to add a user to a group by providing the group name and both the distinguishedName and sAMAccountName of the user.
- RemoveUserFromGroup - allows you to remove a user from a group by providing the group name and both the distinguishedName and sAMAccountName of the user.
- Enable User - allows you to enable or disable a user by providing the enable parameter and both the distinguishedName and sAMAccountName of the user. The enable parameter is either true or false.
- MoveUser - allows you to move a user to a specific path in your directory by providing the destination path and both the distinguishedName and sAMAccountName of the user.
Lets take the CreateUser function as an example to show how these functions work. As mentioned earlier, we need to use the Data rules to use these functions and for this example we use the Create item rule which is available from the Data rules.
When creating a user in Active Directory, there are some required properties that we need to provide. Those properties are a username, givenName (first name), surname (last name), email and password. There are also extra properties that can be provided by expanding a properties tab within the function:
We need to create at least five fields that will be used to provide a value as the required properties. We will use a text box field for each one:
Use the create item rule to use the function. We need to map the text box fields to the appropriate properties as follow:
You can apply the create item rule to a button, for example, the submit button. This will result in a user being created in your AD whenever the submit button will be clicked.
Your Active Directory connector is now set up and ready to be used in your processes. To find out more about how to design processes go to Designer.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.