File Manager - BorneoXploit

Editing: user_auth_ldap_api.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
 <meta charset="utf-8" />
 <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />

<a href="../contents.html">
 
 <img src="../_static/logo-white.png" class="logo" alt="Logo"/>
 </a>
 <div class="switch-menus">
 <div class="version-switch"></div>
 <div class="language-switch"></div>
 </div>
<div role="search">
 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
</div>
 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
 Getting Started
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../declarations/index.html">Declarations</a></li>
</ul>
Release notes
<ul>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Critical changes</a></li>
</ul>
Installation
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
</ul>
Configuration
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../occ_command.html">Using the occ command</a></li>
<li class="toctree-l1"><a class="reference internal" href="../reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../webhook_listeners/index.html">Webhook Listeners</a></li>
<li class="toctree-l1"><a class="reference internal" href="../windmill_workflows/index.html">Windmill Workflows</a></li>
</ul>
Files
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</a></li>
</ul>
Apps
<ul>
<li class="toctree-l1"><a class="reference internal" href="../apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../exapps_management/index.html">ExApps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ai/index.html">Artificial Intelligence</a></li>
</ul>
Users
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">User management</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html">User management</a></li>
<li class="toctree-l2"><a class="reference internal" href="reset_admin_password.html">Resetting a lost admin password</a></li>
<li class="toctree-l2"><a class="reference internal" href="reset_user_password.html">Resetting a user password</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_password_policy.html">User password policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html">User authentication with LDAP</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_cleanup.html">LDAP user cleanup</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The LDAP configuration API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#creating-a-configuration">Creating a configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#example">Example</a></li>
<li class="toctree-l4"><a class="reference internal" href="#xml-output">XML output</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#deleting-a-configuration">Deleting a configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id1">Example</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id2">XML output</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#reading-a-configuration">Reading a configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id3">Example</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id4">XML output</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#modifying-a-configuration">Modifying a configuration</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#id5">Example</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id6">XML output</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#configuration-keys">Configuration keys</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a></li>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html">Profile configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_oidc.html">User authentication with OpenID Connect</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../desktop/index.html">Desktop Clients</a></li>
</ul>
Groupware
<ul>
<li class="toctree-l1"><a class="reference internal" href="../groupware/index.html">Groupware</a></li>
</ul>
Office
<ul>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</a></li>
</ul>
Maintenance
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration_monitoring/index.html">Monitoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="../maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../issues/index.html">Issues and troubleshooting</a></li>
</ul>
Links
<ul>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/">Community Help Forum</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">User Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">Developer Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/install/">Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://apps.nextcloud.com">App Store</a></li>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/t/translation-knowledge-valid-for-the-entire-nextcloud-project-wiki/51550">Translations</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule">Supported versions</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/enterprise/">Nextcloud Enterprise</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/blob/master/COPYING-README">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/">Nextcloud GmbH</a></li>
</ul>

</div>
 </div>
 </nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
 
 <a href="../contents.html">Nextcloud latest Administration Manual</a>
 </nav>

<div class="wy-nav-content">
 <div class="rst-content style-external-links">
 <div role="navigation" aria-label="Page navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="../contents.html" class="icon icon-home" aria-label="Home"></a></li>
 <li class="breadcrumb-item"><a href="index.html">User management</a></li>
 <li class="breadcrumb-item active">The LDAP configuration API</li>
 <li class="wy-breadcrumbs-aside">
 <a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_auth_ldap_api.rst" class="fa fa-github"> Edit on GitHub</a>
 </li>
 </ul>
 <hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 
 <section id="the-ldap-configuration-api">
<h1>The LDAP configuration API<a class="headerlink" href="#the-ldap-configuration-api" title="Link to this heading"></a></h1>
All methods require that the “OCS-APIREQUEST” header be set to “true”. Methods take an optional “format” parameter, which may be “xml” (the default) or “json”.
<section id="creating-a-configuration">
<h2>Creating a configuration<a class="headerlink" href="#creating-a-configuration" title="Link to this heading"></a></h2>
Creates a new and empty LDAP configuration. It returns its ID. Authentication is done by sending a
basic HTTP authentication header.
Syntax: ocs/v2.php/apps/user_ldap/api/v1/config
<ul class="simple">
<li>HTTP method: POST</li>
</ul>
<section id="example">
<h3>Example<a class="headerlink" href="#example" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>$ curl -X POST https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config -H &quot;OCS-APIREQUEST: true&quot;
</pre></div>
</div>
<ul class="simple">
<li>Creates a new, empty configuration</li>
</ul>
</section>
<section id="xml-output">
<h3>XML output<a class="headerlink" href="#xml-output" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;ocs&gt;
 &lt;meta&gt;
 &lt;status&gt;ok&lt;/status&gt;
 &lt;statuscode&gt;200&lt;/statuscode&gt;
 &lt;message&gt;OK&lt;/message&gt;
 &lt;/meta&gt;
 &lt;data&gt;
 &lt;configID&gt;s01&lt;/configID&gt;
 &lt;/data&gt;
&lt;/ocs&gt;
</pre></div>
</div>
</section>
</section>
<section id="deleting-a-configuration">
<h2>Deleting a configuration<a class="headerlink" href="#deleting-a-configuration" title="Link to this heading"></a></h2>
Deletes a given LDAP configuration. Authentication is done by sending a basic HTTP authentication header.
Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}
<ul class="simple">
<li>HTTP method: DELETE</li>
</ul>
<section id="id1">
<h3>Example<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>$ curl -X DELETE ``https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s02 -H &quot;OCS-APIREQUEST: true&quot;
</pre></div>
</div>
<ul class="simple">
<li>deletes the LDAP configuration</li>
</ul>
</section>
<section id="id2">
<h3>XML output<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;ocs&gt;
 &lt;meta&gt;
 &lt;status&gt;ok&lt;/status&gt;
 &lt;statuscode&gt;200&lt;/statuscode&gt;
 &lt;message&gt;OK&lt;/message&gt;
 &lt;/meta&gt;
 &lt;data/&gt;
&lt;/ocs&gt;
</pre></div>
</div>
</section>
</section>
<section id="reading-a-configuration">
<h2>Reading a configuration<a class="headerlink" href="#reading-a-configuration" title="Link to this heading"></a></h2>
Returns all keys and values of the specified LDAP configuration. Authentication is done by sending a basic HTTP authentication header.
Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}
<ul class="simple">
<li>HTTP method: GET</li>
<li>url argument: showPassword - int, optional, default 0, whether to return the password in clear text</li>
</ul>
<section id="id3">
<h3>Example<a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>$ curl -X GET https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s02?showPassword=1 -H &quot;OCS-APIREQUEST: true&quot;
</pre></div>
</div>
<ul class="simple">
<li>fetches the LDAP configuration</li>
</ul>
</section>
<section id="id4">
<h3>XML output<a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;ocs&gt;
 &lt;meta&gt;
 &lt;status&gt;ok&lt;/status&gt;
 &lt;statuscode&gt;200&lt;/statuscode&gt;
 &lt;message&gt;OK&lt;/message&gt;
 &lt;/meta&gt;
 &lt;data&gt;
 &lt;ldapHost&gt;ldap://ldap.server.tld&lt;/ldapHost&gt;
 &lt;ldapPort&gt;389&lt;/ldapPort&gt;
 &lt;ldapBackupHost&gt;&lt;/ldapBackupHost&gt;
 &lt;ldapBackupPort&gt;&lt;/ldapBackupPort&gt;
 &lt;ldapBase&gt;ou=Department XLII,dc=example,dc=com&lt;/ldapBase&gt;
 &lt;ldapBaseUsers&gt;ou=users,ou=Department XLII,dc=example,dc=com&lt;/ldapBaseUsers&gt;
 &lt;ldapBaseGroups&gt;ou=Department XLII,dc=example,dc=com&lt;/ldapBaseGroups&gt;
 &lt;ldapAgentName&gt;cn=root,dc=example,dc=com&lt;/ldapAgentName&gt;
 &lt;ldapAgentPassword&gt;Secret&lt;/ldapAgentPassword&gt;
 &lt;ldapTLS&gt;1&lt;/ldapTLS&gt;
 &lt;turnOffCertCheck&gt;0&lt;/turnOffCertCheck&gt;
 &lt;ldapIgnoreNamingRules/&gt;
 &lt;ldapUserDisplayName&gt;displayname&lt;/ldapUserDisplayName&gt;
 &lt;ldapUserDisplayName2&gt;uid&lt;/ldapUserDisplayName2&gt;
 &lt;ldapGidNumber&gt;gidNumber&lt;/ldapGidNumber&gt;
 &lt;ldapUserFilterObjectclass&gt;inetOrgPerson&lt;/ldapUserFilterObjectclass&gt;
 &lt;ldapUserFilterGroups&gt;&lt;/ldapUserFilterGroups&gt;
 &lt;ldapUserFilter&gt;(&amp;amp;(objectclass=nextcloudUser)(nextcloudEnabled=TRUE))&lt;/ldapUserFilter&gt;
 &lt;ldapUserFilterMode&gt;1&lt;/ldapUserFilterMode&gt;
 &lt;ldapGroupFilter&gt;(&amp;amp;(|(objectclass=nextcloudGroup)))&lt;/ldapGroupFilter&gt;
 &lt;ldapGroupFilterMode&gt;0&lt;/ldapGroupFilterMode&gt;
 &lt;ldapGroupFilterObjectclass&gt;nextcloudGroup&lt;/ldapGroupFilterObjectclass&gt;
 &lt;ldapGroupFilterGroups&gt;&lt;/ldapGroupFilterGroups&gt;
 &lt;ldapGroupMemberAssocAttr&gt;memberUid&lt;/ldapGroupMemberAssocAttr&gt;
 &lt;ldapGroupDisplayName&gt;cn&lt;/ldapGroupDisplayName&gt;
 &lt;ldapLoginFilter&gt;(&amp;amp;(|(objectclass=inetOrgPerson))(uid=%uid))&lt;/ldapLoginFilter&gt;
 &lt;ldapLoginFilterMode&gt;0&lt;/ldapLoginFilterMode&gt;
 &lt;ldapLoginFilterEmail&gt;0&lt;/ldapLoginFilterEmail&gt;
 &lt;ldapLoginFilterUsername&gt;1&lt;/ldapLoginFilterUsername&gt;
 &lt;ldapLoginFilterAttributes&gt;&lt;/ldapLoginFilterAttributes&gt;
 &lt;ldapQuotaAttribute&gt;&lt;/ldapQuotaAttribute&gt;
 &lt;ldapQuotaDefault&gt;20 MB&lt;/ldapQuotaDefault&gt;
 &lt;ldapEmailAttribute&gt;mail&lt;/ldapEmailAttribute&gt;
 &lt;ldapCacheTTL&gt;600&lt;/ldapCacheTTL&gt;
 &lt;ldapUuidUserAttribute&gt;auto&lt;/ldapUuidUserAttribute&gt;
 &lt;ldapUuidGroupAttribute&gt;auto&lt;/ldapUuidGroupAttribute&gt;
 &lt;ldapOverrideMainServer&gt;&lt;/ldapOverrideMainServer&gt;
 &lt;ldapConfigurationActive&gt;1&lt;/ldapConfigurationActive&gt;
 &lt;ldapAttributesForUserSearch&gt;uid;sn;givenname&lt;/ldapAttributesForUserSearch&gt;
 &lt;ldapAttributesForGroupSearch&gt;&lt;/ldapAttributesForGroupSearch&gt;
 &lt;ldapExperiencedAdmin&gt;0&lt;/ldapExperiencedAdmin&gt;
 &lt;homeFolderNamingRule&gt;attr:mail&lt;/homeFolderNamingRule&gt;
 &lt;hasPagedResultSupport&gt;&lt;/hasPagedResultSupport&gt;
 &lt;hasMemberOfFilterSupport&gt;1&lt;/hasMemberOfFilterSupport&gt;
 &lt;useMemberOfToDetectMembership&gt;1&lt;/useMemberOfToDetectMembership&gt;
 &lt;ldapExpertUsernameAttr&gt;&lt;/ldapExpertUsernameAttr&gt;
 &lt;ldapExpertUUIDUserAttr&gt;&lt;/ldapExpertUUIDUserAttr&gt;
 &lt;ldapExpertUUIDGroupAttr&gt;&lt;/ldapExpertUUIDGroupAttr&gt;
 &lt;lastJpegPhotoLookup&gt;0&lt;/lastJpegPhotoLookup&gt;
 &lt;ldapNestedGroups&gt;0&lt;/ldapNestedGroups&gt;
 &lt;ldapPagingSize&gt;500&lt;/ldapPagingSize&gt;
 &lt;turnOnPasswordChange&gt;1&lt;/turnOnPasswordChange&gt;
 &lt;ldapDynamicGroupMemberURL&gt;&lt;/ldapDynamicGroupMemberURL&gt;
 &lt;ldapDefaultPPolicyDN&gt;&lt;/ldapDefaultPPolicyDN&gt;
 &lt;/data&gt;
&lt;/ocs&gt;
</pre></div>
</div>
</section>
</section>
<section id="modifying-a-configuration">
<h2>Modifying a configuration<a class="headerlink" href="#modifying-a-configuration" title="Link to this heading"></a></h2>
Updates a configuration with the provided values. Authentication is done by sending a basic HTTP authentication header.
Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}
<ul class="simple">
<li>HTTP method: PUT</li>
<li>url argument: configData - array, see table below for the fields. All fields are optional. The values must be url-encoded.</li>
</ul>
<section id="id5">
<h3>Example<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre>$ curl -X PUT https://admin:secret@example.com/ocs/v2.php/apps/user_ldap/api/v1/config/s01 -H &quot;OCS-APIREQUEST: true&quot; -d &quot;configData[ldapHost]=ldap%3A%2F%2Fldap.server.tld &amp;configData[ldapPort]=389&quot;
</pre></div>
</div>
<ul class="simple">
<li>updates the LDAP configuration</li>
</ul>
</section>
<section id="id6">
<h3>XML output<a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre>&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;ocs&gt;
 &lt;meta&gt;
 &lt;status&gt;ok&lt;/status&gt;
 &lt;statuscode&gt;200&lt;/statuscode&gt;
 &lt;message&gt;OK&lt;/message&gt;
 &lt;/meta&gt;
 &lt;data/&gt;
&lt;/ocs&gt;
</pre></div>
</div>
</section>
</section>
<section id="configuration-keys">
<h2>Configuration keys<a class="headerlink" href="#configuration-keys" title="Link to this heading"></a></h2>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Key</th>
<th class="head">Mode</th>
<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td>ldapHost</td>
<td>rw</td>
<td>yes</td>
<td>LDAP server host, supports protocol</td>
</tr>
<tr class="row-odd"><td>ldapPort</td>
<td>rw</td>
<td>yes</td>
<td>LDAP server port</td>
</tr>
<tr class="row-even"><td>ldapBackupHost</td>
<td>rw</td>
<td>no</td>
<td>LDAP replica host</td>
</tr>
<tr class="row-odd"><td>ldapBackupPort</td>
<td>rw</td>
<td>no</td>
<td>LDAP replica port</td>
</tr>
<tr class="row-even"><td>ldapOverrideMainServer</td>
<td>rw</td>
<td>no</td>
<td>Whether replica should be used instead</td>
</tr>
<tr class="row-odd"><td>ldapBase</td>
<td>rw</td>
<td>yes</td>
<td>Base</td>
</tr>
<tr class="row-even"><td>ldapBaseUsers</td>
<td>rw</td>
<td>no</td>
<td>Base for users, defaults to general base if not specified</td>
</tr>
<tr class="row-odd"><td>ldapBaseGroups</td>
<td>rw</td>
<td>no</td>
<td>Base for groups, defaults to general base if not specified</td>
</tr>
<tr class="row-even"><td>ldapAgentName</td>
<td>rw</td>
<td>no</td>
<td>DN for the (service) user to connect to LDAP</td>
</tr>
<tr class="row-odd"><td>ldapAgentPassword</td>
<td>rw</td>
<td>no</td>
<td>Password for the service user</td>
</tr>
<tr class="row-even"><td>ldapTLS</td>
<td>rw</td>
<td>no</td>
<td>Whether to use StartTLS</td>
</tr>
<tr class="row-odd"><td>turnOffCertCheck</td>
<td>rw</td>
<td>no</td>
<td>Turns off certificate validation for TLS connections</td>
</tr>
<tr class="row-even"><td>ldapIgnoreNamingRules</td>
<td>rw</td>
<td>no</td>
<td>Backwards compatibility, do not set it.</td>
</tr>
<tr class="row-odd"><td>ldapUserDisplayName</td>
<td>rw</td>
<td>yes</td>
<td>Attribute used as display name for users</td>
</tr>
<tr class="row-even"><td>ldapUserDisplayName2</td>
<td>rw</td>
<td>no</td>
<td>Additional attribute, if set show on brackets next to the main attribute</td>
</tr>
<tr class="row-odd"><td>ldapUserAvatarRule</td>
<td>rw</td>
<td>no</td>
<td>Specify the avatar integration behavior, possible values: “default”, “none”, “<a class="reference external" href="data:$ATTRIBUTENAME">data:$ATTRIBUTENAME</a>”</td>
</tr>
<tr class="row-even"><td>ldapGidNumber</td>
<td>rw</td>
<td>no</td>
<td>group ID attribute, needed for primary groups on OpenLDAP (and compatible)</td>
</tr>
<tr class="row-odd"><td>ldapUserFilterObjectclass</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-even"><td>ldapUserFilterGroups</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-odd"><td>ldapUserFilter</td>
<td>rw</td>
<td>yes</td>
<td>LDAP Filter used to retrieve user</td>
</tr>
<tr class="row-even"><td>ldapUserFilterMode</td>
<td>rw</td>
<td>no</td>
<td>used by the Settings Wizard, set to 1 for manual editing</td>
</tr>
<tr class="row-odd"><td>ldapAttributesForUserSearch</td>
<td>rw</td>
<td>no</td>
<td>attributes to be matched when searching for users. separate by ;</td>
</tr>
<tr class="row-even"><td>ldapGroupFilter</td>
<td>rw</td>
<td>no</td>
<td>LDAP Filter used to retrieve groups</td>
</tr>
<tr class="row-odd"><td>ldapGroupFilterMode</td>
<td>rw</td>
<td>no</td>
<td>used by the Settings Wizard, set to 1 for manual editing</td>
</tr>
<tr class="row-even"><td>ldapGroupFilterObjectclass</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-odd"><td>ldapGroupFilterGroups</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-even"><td>ldapGroupMemberAssocAttr</td>
<td>rw</td>
<td>no</td>
<td>attribute that indicates group members, one of: member, memberUid, uniqueMember, gidNumber</td>
</tr>
<tr class="row-odd"><td>ldapGroupDisplayName</td>
<td>rw</td>
<td>no</td>
<td>Attribute used as display name for groups, required if groups are used</td>
</tr>
<tr class="row-even"><td>ldapAttributesForGroupSearch</td>
<td>rw</td>
<td>no</td>
<td>attributes to be matched when searching for groups. separate by ;</td>
</tr>
<tr class="row-odd"><td>ldapLoginFilter</td>
<td>rw</td>
<td>yes</td>
<td>LDAP Filter used to authenticate users</td>
</tr>
<tr class="row-even"><td>ldapLoginFilterMode</td>
<td>rw</td>
<td>no</td>
<td>used by the Settings Wizard, set to 1 for manual editing</td>
</tr>
<tr class="row-odd"><td>ldapLoginFilterEmail</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-even"><td>ldapLoginFilterUsername</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-odd"><td>ldapLoginFilterAttributes</td>
<td>rw</td>
<td>no</td>
<td>set by the Settings Wizard (web UI)</td>
</tr>
<tr class="row-even"><td>ldapQuotaAttribute</td>
<td>rw</td>
<td>no</td>
<td>LDAP attribute containing the quote value (per user)</td>
</tr>
<tr class="row-odd"><td>ldapQuotaDefault</td>
<td>rw</td>
<td>no</td>
<td>Default Quota, if specified quota attribute is empty</td>
</tr>
<tr class="row-even"><td>ldapEmailAttribute</td>
<td>rw</td>
<td>no</td>
<td>LDAP attribute containing the email address (takes first if multiple are stored)</td>
</tr>
<tr class="row-odd"><td>ldapCacheTTL</td>
<td>rw</td>
<td>no</td>
<td>How long results from LDAP are cached, defaults to 10min</td>
</tr>
<tr class="row-even"><td>ldapUuidUserAttribute</td>
<td>r</td>
<td>no</td>
<td>set in runtime</td>
</tr>
<tr class="row-odd"><td>ldapUuidGroupAttribute</td>
<td>r</td>
<td>no</td>
<td>set in runtime</td>
</tr>
<tr class="row-even"><td>ldapConfigurationActive</td>
<td>rw</td>
<td>no</td>
<td>whether this configuration is active. 1 is on, 0 is off.</td>
</tr>
<tr class="row-odd"><td>ldapExperiencedAdmin</td>
<td>rw</td>
<td>no</td>
<td>used by the Settings Wizard, set to 1 for manual editing</td>
</tr>
<tr class="row-even"><td>homeFolderNamingRule</td>
<td>rw</td>
<td>no</td>
<td>LDAP attribute to use a user folder name</td>
</tr>
<tr class="row-odd"><td>hasPagedResultSupport</td>
<td>r</td>
<td>no</td>
<td>set in runtime</td>
</tr>
<tr class="row-even"><td>hasMemberOfFilterSupport</td>
<td>r</td>
<td>no</td>
<td>set in runtime</td>
</tr>
<tr class="row-odd"><td>useMemberOfToDetectMembership</td>
<td>rw</td>
<td>no</td>
<td>Whether to use memberOf to detect group memberships</td>
</tr>
<tr class="row-even"><td>ldapExpertUsernameAttr</td>
<td>rw</td>
<td>no</td>
<td>LDAP attribute to use as internal username. Might be modified (e.g. to avoid name collisions, character restrictions)</td>
</tr>
<tr class="row-odd"><td>ldapExpertUUIDUserAttr</td>
<td>rw</td>
<td>no</td>
<td>override the LDAP servers UUID attribute to identify LDAP user records</td>
</tr>
<tr class="row-even"><td>ldapExpertUUIDGroupAttr</td>
<td>rw</td>
<td>no</td>
<td>override the LDAP servers UUID attribute to identify LDAP group records</td>
</tr>
<tr class="row-odd"><td>lastJpegPhotoLookup</td>
<td>r</td>
<td>no</td>
<td>set in runtime</td>
</tr>
<tr class="row-even"><td>ldapNestedGroups</td>
<td>rw</td>
<td>no</td>
<td>Whether LDAP supports nested groups</td>
</tr>
<tr class="row-odd"><td>ldapPagingSize</td>
<td>rw</td>
<td>no</td>
<td>Number of results to return per page</td>
</tr>
<tr class="row-even"><td>turnOnPasswordChange</td>
<td>rw</td>
<td>no</td>
<td>Whether users are allowed to change passwords (hashing must happen on LDAP!)</td>
</tr>
<tr class="row-odd"><td>ldapDynamicGroupMemberURL</td>
<td>rw</td>
<td>no</td>
<td>URL for dynamic groups</td>
</tr>
<tr class="row-even"><td>ldapDefaultPPolicyDN</td>
<td>rw</td>
<td>no</td>
<td>PPolicy DN for password rules</td>
</tr>
<tr class="row-odd"><td>ldapConnectionTimeout</td>
<td>rw</td>
<td>no</td>
<td>Set the <code class="docutils literal notranslate">LDAP_OPT_NETWORK_TIMEOUT</code> connection options. Default to 15 sec.</td>
</tr>
</tbody>
</table>
</section>
</section>

</div>
 </div>
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 <a href="user_auth_ldap_cleanup.html" class="btn btn-neutral float-left" title="LDAP user cleanup" accesskey="p" rel="prev"> Previous</a>
 <a href="user_provisioning_api.html" class="btn btn-neutral float-right" title="User provisioning API" accesskey="n" rel="next">Next </a>
 </div>

<hr/>

<div role="contentinfo">
 &#169; Copyright 2016-2026 Nextcloud GmbH and Nextcloud contributors.
 </div>

</footer>
 </div>
 </div>
 </section>
 </div>

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
 
 ☁️ latest
 
 
 <div class="rst-other-versions">
 <dl>
 <dt>☁️ Versions</dt>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/latest/admin_manual"
 
 style="color: var(--dark-link-color);"
 
 >
 latest
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/stable/admin_manual"
 
 >
 stable
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/32/admin_manual"
 
 >
 32
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/31/admin_manual"
 
 >
 31
 </a>
 </dd>
 
 </dl>
 </div>
 </div>
<script>
 jQuery(function () {
 SphinxRtdTheme.Navigation.enable(true);
 });
 </script>

</body>
</html>

Cancel