For the complete documentation index, see llms.txt. This page is also available as Markdown.

RemoveUserFromGroups

Remove a user from Active Directory groups.

Task version: 1.1.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: https://github.com/FrendsPlatform/Frends.LDAP

Task Parameters

Name
Description

UserDistinguishedName : String

User's distinguished name (DN)

Default: - Example: CN=Tes Tuser,ou=users,dc=wimpi,dc=net

GroupDistinguishedName : String

Group's distinguished name (DN)

Default: - Example: cn=admin,ou=roles,dc=wimpi,dc=net

HandleLDAPError : HandleLDAPError

How to handle LDAP errors.

Possible values:

  • Throw: Throw an error.

  • Skip: Do nothing and add LDAP error message to the task's result.

Default: Throw Example: HandleLDAPError.Throw

Name
Description

Host : String

LDAP server host.

This must resolve to a Domain Controller (FQDN) in the same domain

as the target group being modified.

Default: - Example: dc1.emea.company.com

Port : Int32

Port. Value 0 = use LDAP/LDAPS default port which is 389 or 636 depending on (SecureSocketLayer) and (TLS).

Default: 0 Example: 389

SecureSocketLayer : Boolean

Perform secure operation.

Default: - Example: true

TLS : Boolean

Connection is protected by TLS.

Default: - Example: true

User : String

User.

Default: - Example: Foo

🗝Password : String

Password.

Default: - Example: Bar123

Task Result

Name
Description

Success : Boolean

User has been removed from group(s). Example: true

Error : String

LDAP Error message. Example: No Such Attribute

UserDistinguishedName : String

User DN. Example: CN=Tes Tuser,ou=users,dc=wimpi,dc=net

GroupDistinguishedName : String

Group DN. Example: cn=admin,ou=roles,dc=wimpi,dc=net

Task Changelog

Changelog for Task Frends.LDAP.RemoveUserFromGroups.

[1.1.0] - 2026-02-03

Changed

  • Improved documentation for Host parameter usage

[1.0.0] - 2022-10-13

Added

  • Initial implementation

Last updated

Was this helpful?