Skip to main content

getLdapUsers

Function getLdapUsers in pulumi-portainer.
2 min read

Function getLdapUsers in pulumi-portainer.

Invoke token: portainer:index/getLdapUsers:getLdapUsers.

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.

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

Arguments#

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

Result#

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

GetLdapUsersSearch (input)#

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

PropertyTypeRequiredDescription
baseDnstringyesDistinguished name the search starts from.
filterstringnoLDAP filter narrowing the search, for example (objectClass=person).
userNameAttributestringnoAttribute holding the login name, for example uid or sAMAccountName.

GetLdapUsersEntry#

Output object GetLdapUsersEntry. Fields below belong to this object.

PropertyTypeAlways presentDescription
groupsstring[]no
namestringno

GetLdapUsersSearch (output)#

Output object GetLdapUsersSearch. Fields below belong to this object.

PropertyTypeAlways presentDescription
baseDnstringyesDistinguished name the search starts from.
filterstringnoLDAP filter narrowing the search, for example (objectClass=person).
userNameAttributestringnoAttribute holding the login name, for example uid or sAMAccountName.