Skip to main content

AD: Get Organizational Units

Description

Use the step to get the list of active organizational units for a specified path.

important

It is a row generating step and hence has to be the first step in a workflow.

Configurations

Field nameDescription
Step nameSpecify a unique name for the step.
CONNECTION tab:Connection fields
Server NameSpecify the Hostname or Server Name or Fully Qualified Domain Name or IP address of machine where Active Directory is hosted.
The field is mandatory.
PortThe port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used that is, 389.
Port should be an integer.
UsernameProvide User Logon Name (e.g. sbrown, scott.brown etc.) or User Principal Name (e.g. sbrown@autoedge.com) of an Active Directory account to authenticate.
This field is mandatory.
PasswordSpecify the password for the username above. Password field appears as Text box and accepts static values or variables.
The data type is string. The field is mandatory.
Button: Test ConnectionVerifies whether the connection is available or not. For the purpose of verification fields coming from previous steps are not allowed. Static values and environment variables are allowed.
INPUT tab:Input fields
PathSpecify an Active Directory Path (Canonical name or Distinguished Name of an object) for which we wish to get all Organizational Units.
  • Canonical Name can be viewed under Properties (while Advanced Features are enabled in View menu) under Object in AD.
  • Distinguished can be viewed under Properties (while Advanced Features are enabled in View menu) under Attribute Editor in AD.

Path data type is String. Path is mandatory.
Note: Double quotes (") and back quote (`) are not required as part of input.
Search ScopeMouse hover on this element to see the allowed values ‘Base’, ‘OneLevel’, ‘SubTree’, OR ‘0’, ‘1’, ‘2’. Specifies the scope of an Active Directory search. The acceptable values for this parameter are as follows:
  • Base or 0: Base or 0 searches only the current path or object.
  • OneLevel or 1: OneLevel or 1 searches the immediate children of that path or object and excludes the base object itself.
  • SubTree or 2: Subtree or 2 searches the current path or object and all children of that path or object.

Search Scope data type is String. It is mandatory.
Note: Double quotes (") and back quote (`) are not required as input.
OUTPUT tab:Output fields
OU NameSpecify a field name to store the OU names retrieved. The default value is “OU Name".
Distinguished NameSpecify a field name to store the Distinguished Names of the OU names retrieved. The default value is “Distinguished Name”.