Active Directory

Active Directory


Active Directory

Active Directory plugin steps are for the purpose of automating Microsoft Windows Active Directory tasks.

Prerequisites:

  1. Process Studio 5.0.0 and above, AutomationEdge 5.0.0 onwards
  2. Privileges to access Active Directory Server.
  3. PowerShell version 5 and above.
  4. To run AD steps PowerShell setup with Active Directory Modules must be done.
  5. Please refer Appendix 2: PowerShell Setup- Active Directory  for updating PowerShell Version and Active Directory module installation.

Below, is a documentation of the AD Plugin step’s. 


Add to Group

Description

This step is used to add existing Active Directory Account to an Active Directory Group. 

Configurations 

Input Tab:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Value as variable/static

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text Var (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies whether the connection is available or not.

For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Object Type

Object  Type allowed values are only “ ’User’,  ‘Computer’, ’Group’

Note: Double quotes (") and back quote (`) are not to be provided.

2

Object Name

Provide Object name of an existing account in Active Directory to Add to Group, corresponding to the Object Type chosen above.

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. For object type Group you may specify Group Name (CN). 
  4. You may specify Distinguished Name or Canonical Name for User, Computer or Group object types.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: Object Name(CN) in Active Directory should not contain a slash(/ or \)

3

Group Name

Existing Active Directory Group Name in formats such as Group Name (CN) or Canonical name or Distinguished name to which we intend to add an existing Active Directory object.

Note: Group Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description


Output Field:


1

Result 

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.

Successful execution shows user has been added to AD group. This field is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 

27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Description

Active Directory: Search Account plugin step provides the list of all Active Directory Users or Groups for the specified Object Type for the Path specified and with Property search criteria provided.

Configurations 

Input Tab:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


6

Password

Specify 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.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Hover over the field to see Allowed values are ‘User’, ‘Group’.  The data type is String. This field is mandatory.

2

Path

Provide the path of an Active Directory object for Advanced Search usually Distinguished name (DN) (e.g. OU=Temp, DC=autoedge, DC=com) or Canonical name (e.g. automationedge.com/Temp) of the object.

The data type is String. This field is mandatory.


Tabular Fields:

Atleast one Property Name, Search Condition and respective Property Value must be selected in the table fields.

3

Property Name

Double click to select Property Names form the pop up window. The data type is String. This field is mandatory. This field is mandatory.

4

Search Condition

Select a Search Condition from the dropdown list. Following are the values in the list. 

The data type is String. This field is mandatory.

  1. Starts with 
  2. Ends with 
  3. Is (exactly)
  4. Is not
  5. Present
  6. Not Present

5

Property Value

Provide a desired property value. 

The data type is String. This field is mandatory.


Output Tab:

No.

Field Name

Description


Output Field:


1

Name

Specify an output field to hold the result- Name upon successful plugin execution. 

The default label value for this field is “Name”. This field is mandatory.

2

Distinguished Name

Specify an output field to hold the result-Distinguished Name on the successful plugin execution. 

The default label value for this field is “DistinguishedName”. This field is mandatory.

Note: 

Advance Search returns Name and Distinguished Name as output. In case you need to use the output of Advanced Search but additionally need User Logon Name then you need to use Get User Properties step after Advanced Search in the workflow to get the User Principal Name by providing DN as input. 

(e.g. Suppose you want to know Does User Exist/ Is Account Locked for all the users returned in Advanced Search, you need User Principal Name to input  DoesUserExist/IsAccountLocked steps. Get User Properties step after Principal Name can fetch the User Principal Name).


Create Account 

Description

Active Directory: Create Account Plugin step is used to create a new Active Directory user.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget called SecuredComboVar. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

First name

First name of the user account to be created. This field is mandatory.

2

Last name

Last name of the user account to be created. This field is mandatory.

3

Full name

Full name of the user account to be created. This field is mandatory.

4

User logon name

Provide User logon name (e.g. sbrown, scott.brown etc.) or User Principal Name (e.g. sbrown@autoedge.com) for the new account to be created. 

User Logon Name is mandatory.

5

User logon password

Provide a password for the user Account to be created.

6

Path

Provide path of Active Directory object (usually DN, For e.g. OU=Temp, DC=autoedge,DC=com) where the User Account is to be created. This field is mandatory.

Note:

The account is created if the password fails for any reason. If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. The user account will still be created and you may use Reset Account Password to set the password on that account. In order to ensure that accounts remain secure, user accounts will never be enabled unless a valid password is set or Password Not Required is set in AD.

Output Tab:

No.

Field Name

Description

1

Result  

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.

Successful execution shows user account has been created.

Result label value is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Create Group

Description

Active Directory: Create Group Plugin step is used to create a new Active Directory Group.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

5

Password

Password is entered using a widget called SecuredComboVar. The widget handles both Text Var (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

6

Button: Test Connection

Verifies whether the connection is available or not.

For the purpose of verification fields coming from previous steps are not allowed as field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.


Input Tab:

No.

Field Name

Description


Input Fields:


1

Group name

Provide an AD Group Name. The Group name must be unique in the active directory domain. This field is mandatory.

2

Group Scope

Allowed values for Group scope are “ ‘0’, ’1’, ’2’ or ‘Domain local’, ’Global’, ’Universal’ ”. This field is mandatory.

3

Group Display Name

Provide a display name of the Group. This field is mandatory.

4

Group Category

Group category allowed values are only “ ‘0’,’1’ or ’Distribution’, ‘Security’”. This field is mandatory.

6

Path

Provide the path of Active Directory object where the Group is to be created - usually Distinguished Name (DN) (e.g. OU=Temp, DC=autoedge, DC=com) or Canonical Name (e.g. automationedge.com/Temp). This field is mandatory.


Output Tab:

No.

Field Name

Description

1

Result  

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.

Successful execution shows user group has been created.

Result label value is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Delete Account

Description

Active Directory: Delete Account step is deletes an Active Directory User Account.


Configurations 

Input Tab:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text Var (static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

User Logon Name

Provide User logon name (e.g. sbrown, scott.brown etc.) or User Principal Name of an existing Active Directory user account (e.g. sbrown@autoedge.com) that is to be deleted. You may also provide the Name (CN)/Distinguished Name/Canonical Name of an Active Directory user account to be deleted.

The data type is String. User Logon Name is mandatory. 

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description


Output Field:


1

Result 

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.

Successful execution shows user account has been deleted. 

Result label value is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Delete Group

Description

Active Directory: Delete Group plugin step deletes an existing Active Directory Group.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Group Name

Specify the Group Name (CN)/Distinguished Name/Canonical Name in active directory to be deleted. This field is mandatory.

Canonical name\Distinguished Name may be provided in the group name field to avoid duplicate group name errors.

Group Name(CN)  in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description

1

Result

Output field to hold the result of the successful plugin execution. The default value of this field is “Result”. This field is mandatory.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Disable Account

Description

Active Directory: Disable Account Plugin step disables a user or computer account.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as a Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Object  Type allowed values are only “ ’User’,  ‘Computer’

Note: Double quotes (") and back quote (`) are not to be provided.

2

Object Name

Provide an existing Active Directory object name (user or computer name) which we intend to disable. 

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. You may specify Distinguished Name or Canonical Name for both User and Computer object type.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Does Group Exist

Description

This plugin checks the current status of an existing Active Directory Group.


Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget called SecuredComboVar. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Group name

Provide Active Directory Group name (CN i.e. Common Name) or Canonical name or Distinguished name to check if it exists. This field is mandatory.

Note: Group Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description

1

Result  

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”.

Successful execution shows whether group exists or does not exist.

Result label value is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Does User Exist

Description

The step is used to check the status of an Active Directory user if it exists or does not exist.


Configurations 

Input Tab:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text Var and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

User Logon Name

Provide User logon name (e.g. sbrown, scott.brown etc.) or User Principal Name of an existing Active Directory user account (e.g. sbrown@autoedge.com) to check if user exists. You may also provide the Name (CN)/Distinguished Name/Canonical Name of an Active Directory user account to be deleted.

The data type is String. User Logon Name is mandatory. 

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description


Output Field:


1

Result 

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”. 

Successful execution shows user exists. Result label value is mandatory.

Failure reasons could be plugin validation related or target system errors such as user does not exist, internet connection does not exist, invalid server configuration details (server has rejected the client credentials), empty fields and others. These errors can be seen in the logging tab of process studio. The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Enable Account

Description

Active Directory: Enable Account step is used to enable a disabled user or computer account.

Configurations 

Configuration:

No.

Field Nameve

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Object Type allowed values are only ‘User’, ‘Computer’.

The data type is String. This field is mandatory. 

Note: Double quotes (") or back quote (`) are not to be provided.

2

Object Name

Specify the name of an existing Active Directory object to be enabled, corresponding to the Object Type chosen above

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. You may specify Distinguished Name or Canonical Name for User, Computer or Group object types.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: Object Name(CN) in Active Directory should not contain a slash(/ or \)


Get Computers

Description

Active Directory: Get Computers plugin step provides the list of all active directory computers on a specified path for the hierarchical scope specified.

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

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


6

Password

Specify 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.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Path

Provide path of Active Directory usually Distinguished Name (DN) (e.g. OU=Temp, DC=autoedge, DC=com or) or Canonical Name (e.g. e.g. automationedge.com/Temp) for which we want to get all the Computers. 

The Data type is String. This field is mandatory.

2

Search Scope

Mouse hover on this element to see the allowed values ‘Base’, ‘OneLevel’, ‘SubTree’, OR ‘0’, ‘1’, ‘2’. 

The Data type is String. This field is mandatory.

Specifies the scope of an Active Directory search. The acceptable values for this parameter are as shown in the table below:

Level

Description

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. 

SubTree or 2

Subtree or 2 searches the current path or object and all children of that path or object.



Output Tab:

No.

Field Name

Description

1

Computers

Specify an output field to hold the Computer Name on the successful plugin execution. The default value for this field is “Computers”.

2

Distinguished Name

Specify an output field to hold the Distinguished Name of a computer on the successful plugin execution. The default value for this field is “DistinguishedName”.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Get Groups

Description

Active Directory: Get Groups plugin step provides the list of all active directory groups on a specified path. 

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

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


5

Password

Specify 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.

6

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Path

Specify an Active Directory Path (Canonical name or Distinguished Name of an object) for which we wish to get all Groups.

  1. Canonical Name can be viewed under Properties (while Advanced Featured are enabled in View menu) under Object
  2. Distinguished Name can be viewed under Properties (while Advanced Features are enabled in View menu) under Attribute Editor.

Path data type is String. Path is mandatory. 

Note: Double quotes (") and back quote (`) are not required as part of input.

2

Search Scope

Mouse 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 shown in the table below:

Level

Description

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:

No.

Field Name

Description

1

Groups

Specify an output field to hold the result of the successful plugin execution. Default label value for this field is “Groups”.

Result label value is mandatory.

2

Distinguished Name

Specify a field name to store the Distinguished Names of the Groups retrieved. The default value is “Distinguished Name”.

Result label value is mandatory.

Errors can be captured using error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Get Group Properties 

Description

Active Directory: Get Group Properties plugin step gets the properties of an Active Directory Group.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as a Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Group Name

Specify an Active Directory Group Name (CN)\Canonical Name\ Distinguished Name to get the Group properties.

Canonical name\Distinguished Name may be provided to the group name field to avoid duplicate group name errors.

Note: Group Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description


Output Fields Tabular:


1

Property Name

Double click to get a list of Group property names. At least one property name should be selected.

2

Output Field

Specify a field name to store the retrieved property values of the corresponding property names.



Get Organizational Units 

Description

Active Directory: Get Organizational Units plugin step provides the list of all active organizational units for a specified path. 

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

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


5

Password

Specify 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.

6

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:



Path

Specify an Active Directory Path (Canonical name or Distinguished Name of an object) for which we wish to get all Organizational Units.

  1. Canonical Name can be viewed under Properties (while Advanced Features are enabled in View menu) under Object in AD.
  2. 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 Scope

Mouse 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 shown in the table below:

Level

Description

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:

No.

Field Name

Description

1

OU Name

Specify a field name to store the OU names retrieved. The default value is “OU Name”

2

Distinguished Name

Specify a field name to store the Distinguished Names of the OU names retrieved. The default value is “Distinguished Name”

Errors can be captured using error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Get Last Logon Timestamp 

Description

Active Directory: Get Last Logon Timestamp plugin step gets the last logon timestamp of an Active Directory user or computer.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of the machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as a Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Specify Object Type - allowed values are only “’User’ and ‘Computer’”. The data type is String. This field is mandatory.

Note: 

Double quotes (") and back quote (`) are not to be provided.

2

Object Name

Specify an existing Active Directory object name for which we wish to get the last logged in timestamp. 

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. You may specify Distinguished Name or Canonical Name for both User and Computer object type.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description

1

Last LogonTimestamp (UTC)

Output field to hold the result of the successful plugin execution. Default value for this field is “LastLogonTimestamp”. This field is mandatory.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.



Get Users

Description

Active Directory: Get Users step provides the list of all Active Directory users on the Path specifiedThis is a row generating step and hence has to be the first step in a workflow.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


6

Password

Specify 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.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Path

Specify an Active Directory Path (Canonical name or Distinguished Name of an object) for which we wish to get all Users.

Advanced Features must be enabled from View menu to fetch Canonical name or Distinguished Name from the Object Properties.

  1. Canonical Name can be viewed in Properties under Object in AD.
  2. Distinguished Name can be viewed in Properties under Attribute Editor tab in AD.

Path data type is String. Path is mandatory. 

Note: Double quotes (") and back quote (`) are not required as part of input.

2

Search Scope

Mouse 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 shown in the table below:

Level

Description

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:

No.

Field Name

Description

1

Users

Specify an output field to hold the result (User Logon Name/User Principal Name) upon successful plugin execution. The default value for this field is “Users”.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Get User Groups 

Description

Active Directory: Get User Groups step provides the list of all groups for a specified user. This is a row generating step and hence has to be the first step in a workflow.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.


6

Password

Specify 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.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

User Logon Name

Provide User logon name (e.g. sbrown, scott.brown etc.) or User Principal Name (e.g. sbrown@autoedge.com) for which you need all the assigned groups. 

You may also provide the User Name (CN)/Distinguished Name/Canonical Name of an Active Directory user account to fetch assigned groups.

User Logon Name is mandatory.


Output Tab:

No.

Field Name

Description

1

User Groups

Output field to hold the result of the successful plugin execution. Default label value for this field is “User Groups”. Result label value is mandatory.

2

Distinguished Name

Specify an output field to hold the result-Distinguished Name on the successful plugin execution. 

The default label value for this field is “DistinguishedName”. This field is mandatory.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Get User Properties 

Description

Active Directory: Get User Properties step gets the properties of an Active Directory user.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

User Logon Name

Provide User logon name (e.g. sbrown, scott.brown etc.) or User Principal name (e.g. sbrown@autoedge.com) of the user for which you wish to fetch User Properties. 

You may also provide the User Name (CN)/Distinguished Name/Canonical Name of an Active Directory user account to fetch User Properties.

The data type is String. User Logon Name is mandatory. 

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description


Output Tabular Fields: 

At least one Property Name and Respective Output field should be provided.

1

Property Name

On Click, property names associated with the user are retrieved in a list. Select one or more Property Names one by one.

2

Output Field

Specify an output fieldname to hold the value of the corresponding Property Name.


Is Account Disabled 

Description

Active Directory: Is Account Disabled plugin step checks whether the current status of an existing Active Directory account is disabled.

Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text b box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Object Type: Allowed values are ‘User’, ‘Computer’.

The data Type is String. This field is mandatory.

2

Object Name

Specify an existing Active Directory object name for which you wish check if Acount is disabled. 

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. You may specify Distinguished Name or Canonical Name for both User and Computer object type.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description

1

Result  

Specify an output field to hold the result of the plugin execution. Default label value for this field is “Result”. Result label value is mandatory.

If Account is disabled the Result is true else false.


Is Account Locked 

Description

Active Directory: Is Account Locked plugin checks whether the current status of an existing Active Directory account is locked.


Configurations 

Configuration:

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

Server Name

Provide the Hostname/Server Name/Fully Qualified Domain Name/IP address of machine where Active Directory is hosted. This field is mandatory.

3

Port

The port number for Active Directory should be provided. If port number is not provided, internally default port for Active Directory is used i.e. 389. Port should be an integer.

4

Username 

Provide 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.

User Logon Name and User Principal Name are depicted below.



Password:


5

Accept Values from fields

Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. 

Else enable checkbox for Password field to appear as Text box.

6

Password

Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory.

If checkbox above is enabled Password field appears as Text box and accepts static values or variables. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.

7

Button: Test Connection

Verifies 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:

No.

Field Name

Description


Input Fields:


1

Object Type

Specify an Object Type. The allowed values are ‘User’, ‘Computer’.

The data type is string. This field is mandatory.

2

Object Name

Specify an existing Active Directory object name for which you wish check if Acount is locked. 

  1. For object type User in Active Directory you may specify User logon name (e.g. sbrown, scott.brown etc.), User Principal Name (e.g. sbrown@autoedge.com) or User Name (CN). 
  2. For object type Computer you may specify Computer Name (CN). 
  3. You may specify Distinguished Name or Canonical Name for both User and Computer object type.

The data type is string. This field is mandatory.

Object Name must be unique in Active Directory.

Note: User Name(CN) in Active Directory should not contain a slash(/ or \)


Output Tab:

No.

Field Name

Description

1

Result  

Output field to hold the result of the successful plugin execution. Default label value for this field is “Result”. Result label value is mandatory.

The error can be captured in error handling as discussed in 27 Appendix 1: Error Handling in IT Plugins to make the error message visible on AutomationEdge Requests.


Move Account 

Description

Move Account Plugin step is moves a user from one organization (OU) to another organization in Active Directory.