pgsrc/Help%2FLdapSearchPlugin

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