Active Directory Activities on Virtosoftware Guides & Docs

Disable a user account in Active Directory

Thu, 24 Oct 2024 18:11:51 +0000

This activity allows disabling a user account in Active Directory.

SharePoint Workflow Designer Phrase#

Disable this user account in this domain

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom

authentication, use “Set Active Directory authentication” activity before.

Enable a user account in Active Directory

Thu, 24 Oct 2024 18:11:44 +0000

This activity allows enabling a user account in Active Directory.

SharePoint Workflow Designer Phrase#

Enable this user account in this domain

Parameters

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Set user's password in Active Directory

Thu, 24 Oct 2024 18:11:37 +0000

This activity allows changing a password in Active Directory.

By default, activity uses the current user when authenticating. If you want to use custom

authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Set this user new password to this value in this domain.

Parameters

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this value	New password
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Get members of Active Directory group

Thu, 24 Oct 2024 18:11:30 +0000

This activity returns collection of members of Active Directory group. Supports “Distinguished Name” or “Account Name” output format.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

**Note:**Activity reads information from memberattribute. The memberattribute is a multi-valued attribute that contains groups of which the user is a direct member, depending on the domain controller (DC) from which this attribute is retrieved

Get Active Directory groups where user is member

Thu, 24 Oct 2024 18:11:23 +0000

This activity returns collection of Get Active Directory groups where user is member. Supports

“Distinguished Name” or “Account Name” output format.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

**Note:**Activity reads information from memberOfattribute. The memberOfattribute is a multi-valued attribute that contains groups of which the user is a direct member, depending on the domain controller (DC) from which this attribute is retrieved:

Get user emails from Active Directory group

Thu, 24 Oct 2024 18:11:17 +0000

This activity extracts all emails from Active Directory vgroup and stores result in variable. If group includes sub-group, all users from sub-group will be extracted automatically.

You can use it to get email recipients from Active Directory group. The activity enumerates members of AD group, then extracts emails from members and returns a string with unique emails, concatenated by semicolon (“;”).

By default, activity uses the current user when authenticating. If you want to use custom

Delete group from Active Directory

Thu, 24 Oct 2024 18:11:10 +0000

This activity allows removing group from Active Directory.

If the group doesn’t exist, this method throws exception.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Delete this group name from this domain.

Parameters

Parameter	Description
this group name	Group name. Ex: “Administrators”, “DOMAIN\Administrators”,“Administrators@DOMAIN”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the group name.

Create group in Active Directory

Thu, 24 Oct 2024 18:11:02 +0000

This activity allows creating group in Active Directory.

Activity creates group in Active Direcotry and initializes sAMAccountName properties.

AD Property Name	Value
sAMAccountName	group name.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Create in this path, new user with logon name this logon name, first name this first name, last name this last name and password this password.

Delete user from Active Directory

Thu, 24 Oct 2024 18:10:54 +0000

This activity allows removing user from Active Directory.

If the user doesn’t exist, this method throws exception.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Delete this user from this domain.

Parameters

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”Allowed multiple users or groups separated ';'. Ex: “domain\user1;domain\user2”
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Remove all members from Active Directory group

Thu, 24 Oct 2024 18:10:46 +0000

This activity allows removing all members from Active Directory group.

By default, activity uses the current user when authenticating. If you want to use custom

authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Remove all members from this group group in this domain.

Parameters

Parameter	Description
this group	Path to existing user group.Supported formats:Full LDAP path “CN= group,OU=Test,DC=yourdomain,DC=local”Simple path from root with domain “yourdomain\test\group” or “yourdomain/test/group”Simple path from root without domain “test\group” or “test/group”,domain will be resolved automatically.The logon name. Ex: “group”.Use Active Directory Explorer (http://technet.microsoft.com/en- us/sysinternals/bb963907.aspx) to get correct path.Supports multiple destination groups separated ';'.
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Remove member from Active Directory group

Thu, 24 Oct 2024 18:10:39 +0000

This activity allows removing member from Active Directory group.

If the user or secure group doesn’t exist, this method does nothing.

**Note:**Allowed multiple users or groups separated ‘;’.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Remove member this member from this group group in this domain.

Parameters

Parameter	Description
this member	User login name. Ex: “user@domain”, “domain\user” or “user”Allowed multiple users or groups separated ';'. Ex: “user1; domain\user2”
this group	Path to existing user group.Supported formats:Full LDAP path “CN= group,OU=Test,DC=yourdomain,DC=local”Simple path from root with domain “yourdomain\test\group” or “yourdomain/test/group”Simple path from root without domain “test\group” or “test/group”,domain will be resolved automatically.The logon name. Ex: “group”.Use Active Directory Explorer (http://technet.microsoft.com/en- us/sysinternals/bb963907.aspx) to get correct path.

	Supports multiple destination groups separated ';'.
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Add member to Active Directory group

Thu, 24 Oct 2024 18:10:31 +0000

This activity allows adding member to Active Directory group.

If the user or secure group exists, this method does nothing.

**Note:**Allowed multiple users or groups separated ‘;’.

By default, activity uses the current user when authenticating. If you want to use custom

authentication, use “Set Active Directory authentication” activity before.

SharePoint Workflow Designer Phrase#

Add member this member to this group group in this domain.

Parameters

Parameter	Description
this member	User login name. Ex: “user@domain”, “domain\user” or “user”.Allowed multiple users or groups separated ';'. Ex: “user1; domain\user2”
this group	Path to existing user group.Supported formats:Full LDAP path “CN= group,OU=Test,DC=yourdomain,DC=local”Simple path from root with domain “yourdomain\test\group” or

	“yourdomain/test/group”Simple path from root without domain “test\group” or “test/group”,domain will be resolved automatically.The logon name. Ex: “group”.Use Active Directory Explorer (http://technet.microsoft.com/en- us/sysinternals/bb963907.aspx) to get correct LDAP path.Supports multiple destination groups separated ';'.
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

Create user in Active Directory

Thu, 24 Oct 2024 18:10:22 +0000

This activity allows creating user in Active Directory.

Activity creates user in Active Direcotry and initializes sAMAccountName, userPrincipalName, sn, givenName, displayName, userAccountControl properties. You can set additional properties via “Set user’s custom attribute in Active Directory” activity.

AD Property Name	Value
sAMAccountName	Login property value without domain. userlogin@yourdomain.local
userPrincipalName	Login property value. userlogin@yourdomain.local
sn	LastName property value.
givenName	FirstName property value.
displayName	Auto. “[FirstName] [LastName]“
userAccountControl	ADS_UF_NORMAL_ACCOUNT\| ADS_UF_DONT_EXPIRE_PASSWD

By default, activity uses the current user when authenticating. If you want to use custom

Set Active Directory authentication

Thu, 24 Oct 2024 18:10:16 +0000

This activity allows defining Active Directory authentication information for all Active Directory activities below.

SharePoint Workflow Designer Phrase#

Use user name this user, password this password when authentication the Active Directory client.

Parameters

Parameter	Description
this user	The user name to use when authenticating the client. Ex: “user@domain”,“domain\user”.
this password	Password

Set user's custom attribute in Active Directory

Thu, 24 Oct 2024 18:10:07 +0000

This activity allows setting user or secure group custom attribute in Active Directory. Special permissions are required to actually update information.

SharePoint Workflow Designer Phrase#

Set this user this attribute to this value in this domain.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”Allowed multiple users or groups separated ';'. Ex: “user1; domain\user2”
this attribute	Attribute name
this value	Attribute value
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before.

Get user's custom attribute from Active Directory

Thu, 24 Oct 2024 18:09:57 +0000

This activity allows receiving user’s or secure group custom attribute from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user this attribute from this domain and store result in Variable: variable

Parameters#

Parameter	Description
this user	User or secure group login name. Ex: “user@domain”, “domain\user” or “user”
this attribute	Attribute name
this domain	Optional. Domain name. You should enter domain name if user name without adomain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom authentication, use “Set Active Directory authentication” activity before. See “LDAP Attribute” table to determine the attribute name.

Get user's department from Active Directory

Thu, 24 Oct 2024 18:09:45 +0000

This activity allows receiving user’s department from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user department from this domain and store result in Variable: varaible.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom

Get user's manager from Active Directory

Thu, 24 Oct 2024 18:09:38 +0000

This activity allows receiving user’s user manager from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user manager from this domain and store result in Variable: varaible.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom

Get user's job title from Active Directory

Thu, 24 Oct 2024 18:09:29 +0000

This activity allows receiving user’s job title from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user job title name from this domain and store result in Variable: varaible.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom

Get user's email from Active Directory

Thu, 24 Oct 2024 18:09:21 +0000

This activity allows receiving user’s email from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user email from this domain and store result in Variable: varaible.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom

Get user's display name from Active Directory

Thu, 24 Oct 2024 18:09:05 +0000

This activity allows receiving user’s display name from Active Directory and stores result in variable.

If attribute does not exist, this method returns empty string.

SharePoint Workflow Designer Phrase#

Get this user display name from this domain and store result in Variable: varaible.

Parameters#

Parameter	Description
this user	User login name. Ex: “user@domain”, “domain\user” or “user”
this domain	Optional. Domain name. You should enter domain name if user name without a domain, otherwise it will be calculated from the user name.

By default, activity uses the current user when authenticating. If you want to use custom