# RemoveUserFromGroups

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

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

{% tabs %}
{% tab title="Parameter: Input" %}

| Name                                | Description                                                                                                                                                                                                                                                                          |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| UserDistinguishedName : `String`    | <p>User's distinguished name (DN)</p><p><br>Default: <code>-</code><br>Example: <code>CN=Tes Tuser,ou=users,dc=wimpi,dc=net</code></p>                                                                                                                                               |
| GroupDistinguishedName : `String`   | <p>Group's distinguished name (DN)</p><p><br>Default: <code>-</code><br>Example: <code>cn=admin,ou=roles,dc=wimpi,dc=net</code></p>                                                                                                                                                  |
| HandleLDAPError : `HandleLDAPError` | <p>How to handle LDAP errors.</p><p>Possible values:</p><ul><li><code>Throw</code>:</li></ul><p>How to handle LDAP errors.</p><ul><li><code>Skip</code>:</li></ul><p>How to handle LDAP errors.</p><p><br>Default: <code>0</code><br>Example: <code>HandleLDAPError.Throw</code></p> |
| {% endtab %}                        |                                                                                                                                                                                                                                                                                      |

{% tab title="Parameter: Connection" %}

| Name                          | Description                                                                                                                                                                                                                 |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Host : `String`               | <p>LDAP server host.</p><p>This must resolve to a Domain Controller (FQDN) in the same domain</p><p>as the target group being modified.</p><p><br>Default: <code>-</code><br>Example: <code>dc1.emea.company.com</code></p> |
| Port : `Int32`                | <p>Port. Value 0 = use LDAP/LDAPS default port which is 389 or 636 depending on (SecureSocketLayer) and (TLS).</p><p><br>Default: <code>0</code><br>Example: <code>389</code></p>                                           |
| SecureSocketLayer : `Boolean` | <p>Perform secure operation.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p>                                                                                                                            |
| TLS : `Boolean`               | <p>Connection is protected by TLS.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p>                                                                                                                      |
| User : `String`               | <p>User.</p><p><br>Default: <code>-</code><br>Example: <code>Foo</code></p>                                                                                                                                                 |
| 🗝Password : `String`         | <p>Password.</p><p><br>Default: <code>-</code><br>Example: <code>Bar123</code></p>                                                                                                                                          |
| {% endtab %}                  |                                                                                                                                                                                                                             |

{% tab title="Result: Result" %}

| Name                              | Description                                                                    |
| --------------------------------- | ------------------------------------------------------------------------------ |
| Success : `Boolean`               | <p>User has been removed from group(s).<br>Example: <code>true</code></p>      |
| Error : `String`                  | <p>LDAP Error message.<br>Example: <code>No Such Attribute</code></p>          |
| UserDistinguishedName : `String`  | <p>User DN.<br>Example: <code>CN=Tes Tuser,ou=users,dc=wimpi,dc=net</code></p> |
| GroupDistinguishedName : `String` | <p>Group DN.<br>Example: <code>cn=admin,ou=roles,dc=wimpi,dc=net</code></p>    |
| {% endtab %}                      |                                                                                |

{% tab title="Changelog" %}

## Changelog

### \[1.1.0] - 2026-02-03

#### Changed

* Improved documentation for Host parameter usage

### \[1.0.0] - 2022-10-13

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}