# getLdapAdminGroups

> Function getLdapAdminGroups in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Function getLdapAdminGroups in pulumi-portainer.

Invoke token: `portainer:index/getLdapAdminGroups:getLdapAdminGroups`.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const result = await portainer.getLdapAdminGroups({
  url: "<url>",
})
```

`getLdapAdminGroupsOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property             | Type                                           | Required | Description |
| -------------------- | ---------------------------------------------- | -------- | ----------- |
| `adminGroupSearches` | `GetLdapAdminGroupsAdminGroupSearch (input)[]` | no       |             |
| `anonymousMode`      | `boolean`                                      | no       |             |
| `id`                 | `string`                                       | no       |             |
| `password`           | `string`                                       | no       |             |
| `readerDn`           | `string`                                       | no       |             |
| `startTls`           | `boolean`                                      | no       |             |
| `tlsSkipVerify`      | `boolean`                                      | no       |             |
| `url`                | `string`                                       | yes      |             |

## Result

| Property             | Type                                            | Always present | Description |
| -------------------- | ----------------------------------------------- | -------------- | ----------- |
| `adminGroupSearches` | `GetLdapAdminGroupsAdminGroupSearch (output)[]` | no             |             |
| `anonymousMode`      | `boolean`                                       | no             |             |
| `groupNames`         | `string[]`                                      | yes            |             |
| `id`                 | `string`                                        | yes            |             |
| `password`           | `string`                                        | no             |             |
| `readerDn`           | `string`                                        | no             |             |
| `startTls`           | `boolean`                                       | no             |             |
| `tlsSkipVerify`      | `boolean`                                       | no             |             |
| `url`                | `string`                                        | yes            |             |

## `GetLdapAdminGroupsAdminGroupSearch (input)`

Input object `GetLdapAdminGroupsAdminGroupSearch`. Fields below belong to this object, not to the parent.

| Property         | Type     | Required | Description                                      |
| ---------------- | -------- | -------- | ------------------------------------------------ |
| `groupAttribute` | `string` | no       | Attribute on a group entry listing its members.  |
| `groupBaseDn`    | `string` | yes      | Distinguished name the group search starts from. |
| `groupFilter`    | `string` | no       | LDAP filter narrowing the group search.          |

## `GetLdapAdminGroupsAdminGroupSearch (output)`

Output object `GetLdapAdminGroupsAdminGroupSearch`. Fields below belong to this object.

| Property         | Type     | Always present | Description                                      |
| ---------------- | -------- | -------------- | ------------------------------------------------ |
| `groupAttribute` | `string` | no             | Attribute on a group entry listing its members.  |
| `groupBaseDn`    | `string` | yes            | Distinguished name the group search starts from. |
| `groupFilter`    | `string` | no             | LDAP filter narrowing the group search.          |