Skip to main content

AD: Add to Group

Description

Use the step to add an existing Active Directory Account to an Active Directory Group.

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.

PortSpecify the port number for Active Directory. If port number is not provided, use the internal default port for Active Directory, that is, 389.

The port should be an integer.

UsernameSpecify the user's logon name. For example, sbrown, scott.brown, and so on.

Or
Specify the user's principal name. For example, sbrown@autoedge.com of an Active Directory account to authenticate.

The field is mandatory.

Password
Accept value as variable/staticSpecify or select the password, as required.
If the Accept Value as variable/static checkbox is selected, then the password field appears as a text box and accepts static or variable values.
OR
If the Accept Value as variable/static checkbox is clear, then the password field appears as a dropdown in which you can select a field from the previous steps.
Test ConnectionClick to verify if the connection is available or not.
For verification purpose, the 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:Input Fields
Object TypeSpecify the object type from the following: User Or Computer Or Group.

Note: Do not use double quotes (") and back quote (`).

Object NameSpecify the object name of an existing account in Active Directory to add to the group, corresponding to the selected Object Type.
For object type:
* User in Active Directory: You may specify:
User logon name: For example, sbrown, scott.brown, and so on.
OR
User principal name: For example, sbrown@autoedge.com
OR
User name: For example, CN.
* Computer: You may specify Computer Name CN.
* Group: You may specify Group Name GN.
* User, Computer, or Group: You may specify Distinguished Name or Canonical Name.
The data type is string and the field is mandatory.

Note: Object name CN must not contain a slash (/ or \).

Group Name

Select the 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: Object name CN must not contain a slash (/ or \).

OUTPUT tab:Output Field
Result

The field holds the result of the successful plugin execution. The default label for the field is Result. Successful execution shows user has been added to AD group.

The field is mandatory.