Skip to main content

getLdapGroups

Function getLdapGroups in pulumi-portainer.
2 min read

Function getLdapGroups in pulumi-portainer.

Invoke token: portainer:index/getLdapGroups:getLdapGroups.

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.

getLdapGroupsOutput accepts Input values and returns Output of the same result.

Arguments#

PropertyTypeRequiredDescription
anonymousModebooleanno
groupSearchesGetLdapGroupsGroupSearch (input)[]no
idstringno
passwordstringno
readerDnstringno
startTlsbooleanno
tlsSkipVerifybooleanno
urlstringyes

Result#

PropertyTypeAlways presentDescription
anonymousModebooleanno
entriesGetLdapGroupsEntry[]yes
groupSearchesGetLdapGroupsGroupSearch (output)[]no
idstringyes
passwordstringno
readerDnstringno
startTlsbooleanno
tlsSkipVerifybooleanno
urlstringyes

GetLdapGroupsGroupSearch (input)#

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

PropertyTypeRequiredDescription
groupAttributestringnoAttribute on a group entry listing its members.
groupBaseDnstringyesDistinguished name the group search starts from.
groupFilterstringnoLDAP filter narrowing the group search.

GetLdapGroupsEntry#

Output object GetLdapGroupsEntry. Fields below belong to this object.

PropertyTypeAlways presentDescription
groupsstring[]no
namestringno

GetLdapGroupsGroupSearch (output)#

Output object GetLdapGroupsGroupSearch. Fields below belong to this object.

PropertyTypeAlways presentDescription
groupAttributestringnoAttribute on a group entry listing its members.
groupBaseDnstringyesDistinguished name the group search starts from.
groupFilterstringnoLDAP filter narrowing the group search.