pgsrc/Help%2FLdapSearchPlugin

   1 Date: Thu, 26 Mar 2009 11:34:32 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FLdapSearchPlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **~LdapSearch** [[Help:WikiPlugin|plugin]] displays a LDAP query as table.
  12
  13 == Usage
  14 {{{
  15 <<LdapSearch>>
  16 <<LdapSearch
  17            host="localhost"
  18            port=389
  19            basedn=""
  20            filter="(cn=*)"
  21            attributes=""
  22  >>
  23 <<LdapSearch host=ldap.example.com filter="(ou=web-team)"
  24                       attributes="sn cn telephonenumber">>
  25 <<LdapSearch host="ldap.itd.umich.edu" basedn="" filter="(sn=jensen)" attributes="cn drink">>
  26 <<LdapSearch host=ldap.example.com attributes="cn sn telephonenumber">>
  27 <<LdapSearch host=bugs.debian.org port=10101 basedn="dc=current,dc=bugs,dc=debian,dc=org"
  28                       filter="(debbugsPackage=phpwiki)"
  29                       attributes="debbugsSeverity debbugsState debbugsTitle">>
  30 }}}
  31
  32 == Arguments
  33
  34 host _(default: from LDAP_AUTH_HOST or localhost)_:
  35         hostname or ip or ldap:// uri to connect to.
  36
  37 port _(default: from LDAP_AUTH_HOST or 389)_:
  38         portnumber to connect to.
  39
  40 basedn _(default: LDAP_BASE_DN)_:
  41         connect string: "ou=Users,o=Development,dc=mycompany.com"
  42
  43 filter _(default: "(cn=*)")_:
  44         Optional ldap_search() filter argument
  45
  46 attributes _(default: empty)_ :
  47         space seperated fields to return as table columns: "cn sn"
  48
  49 options:
  50         ldap_set_option(). Default: LDAP_SET_OPTION if host == LDAP_AUTH_HOST
  51         Column seperated name=value pairs. Esp. needed for Windows Active directory:
  52         "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
  53 user:
  54         Default: LDAP_AUTH_USER if host == LDAP_AUTH_HOST
  55 password:
  56         Default: LDAP_AUTH_PASSWORD if host == LDAP_AUTH_HOST
  57         user and password are required for Windows Active directory.
  58
  59 == Examples
  60
  61 <<WikiFormRich action=LdapSearch
  62         editbox[] name=host value=bugs.debian.org size=80
  63         editbox[] name=port value=10101 size=80
  64         editbox[] name=basedn value="dc=current,dc=bugs,dc=debian,dc=org" size=80
  65         editbox[] name=filter value="(debbugsPackage=phpwiki)" size=80
  66         editbox[] name=attributes value="debbugsSeverity debbugsState debbugsTitle" size=80
  67         submit[] reset[]
  68 >>
  69
  70 == Author
  71 * [John Lines|PhpWiki:JohnLines]
  72
  73 == See Also
  74
  75 <noinclude>
  76 ----
  77 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  78 </noinclude>