david/therinaldos.com
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

migrate therinaldos.com data
Build & Deploy to DigitalOcean Space / build (push) Failing after 2m38s
Details

Browse Source
This commit is contained in:
david
2024-05-05 15:50:45 -04:00
commit ef1ff240d4
23182 changed files with 3801898 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
wedding-pics/core/doc/admin/configuration_user/index.html
+238
View File
@@ -0,0 +1,238 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User management &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="User management" href="user_configuration.html" />
<link rel="prev" title="Apps management" href="../apps_management.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">User management</a><ul>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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 active">User management</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/index.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="user-management">
<h1>User management<a class="headerlink" href="#user-management" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_configuration.html">User management</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#creating-a-new-user">Creating a new user</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#reset-a-user-s-password">Reset a user’s password</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#renaming-a-user">Renaming a user</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#granting-administrator-privileges-to-a-user">Granting administrator privileges to a user</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#managing-groups">Managing groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#setting-storage-quotas">Setting Storage quotas</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#disable-and-enable-users">Disable and enable users</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_configuration.html#deleting-users">Deleting users</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reset_admin_password.html">Resetting a lost admin password</a></li>
<li class="toctree-l1"><a class="reference internal" href="reset_user_password.html">Resetting a user password</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_password_policy.html">User password policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="two_factor-auth.html">Two-factor authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="two_factor-auth.html#enabling-two-factor-authentication">Enabling two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="two_factor-auth.html#enforcing-two-factor-authentication">Enforcing two-factor authentication</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_auth_ldap.html">User authentication with LDAP</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#advanced-settings">Advanced settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#expert-settings">Expert settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#testing-the-configuration">Testing the configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#additional-configuration-options-via-occ">Additional configuration options via occ</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#nextcloud-avatar-integration">Nextcloud avatar integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#troubleshooting-tips-and-tricks">Troubleshooting, tips and tricks</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#nextcloud-ldap-internals">Nextcloud LDAP internals</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap.html#note">Note</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_auth_ldap_cleanup.html">LDAP user cleanup</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_cleanup.html#deleting-local-nextcloud-users">Deleting local Nextcloud users</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html#creating-a-configuration">Creating a configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html#deleting-a-configuration">Deleting a configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html#reading-a-configuration">Reading a configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html#modifying-a-configuration">Modifying a configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html#configuration-keys">Configuration keys</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="instruction_set_for_users.html">Instruction set for users</a></li>
<li class="toctree-l2"><a class="reference internal" href="instruction_set_for_groups.html">Instruction set for groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="instruction_set_for_apps.html">Instruction set for apps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="profile_configuration.html">Profile configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html#property-scopes">Property scopes</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../apps_management.html" class="btn btn-neutral float-left" title="Apps management" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_configuration.html" class="btn btn-neutral float-right" title="User management" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/instruction_set_for_apps.html
+360
View File
@@ -0,0 +1,360 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Instruction set for apps &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Profile configuration" href="profile_configuration.html" />
<link rel="prev" title="Instruction set for groups" href="instruction_set_for_groups.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_users.html">Instruction set for users</a></li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_groups.html">Instruction set for groups</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Instruction set for apps</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#get-list-of-apps">Get list of apps</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-app-info">Get app info</a></li>
<li class="toctree-l4"><a class="reference internal" href="#enable-an-app">Enable an app</a></li>
<li class="toctree-l4"><a class="reference internal" href="#disable-an-app">Disable an app</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html">Profile configuration</a></li>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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"><a href="user_provisioning_api.html">User provisioning API</a></li>
<li class="breadcrumb-item active">Instruction set for apps</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/instruction_set_for_apps.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="instruction-set-for-apps">
<h1>Instruction set for apps<a class="headerlink" href="#instruction-set-for-apps" title="Link to this heading"></a></h1>
<section id="get-list-of-apps">
<h2>Get list of apps<a class="headerlink" href="#get-list-of-apps" title="Link to this heading"></a></h2>
<p>Returns a list of apps installed on the Nextcloud server. Authentication is done
by sending a Basic HTTP Authorization
header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/apps/</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
<li><p>url argument: filter, string - optional (<code class="docutils literal notranslate"><span class="pre">enabled</span></code> or <code class="docutils literal notranslate"><span class="pre">disabled</span></code>)</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - invalid input data</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Gets enabled apps</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;apps&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>files<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>provisioning_api<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/apps&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-app-info">
<h2>Get app info<a class="headerlink" href="#get-app-info" title="Link to this heading"></a></h2>
<p>Provides information on a specific application. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/apps/{appid}</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/apps/files -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Get app info for the <code class="docutils literal notranslate"><span class="pre">files</span></code> app</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;info/&gt;</span>
<span class="w"> </span><span class="nt">&lt;remote&gt;</span>
<span class="w"> </span><span class="nt">&lt;files&gt;</span>appinfo/remote.php<span class="nt">&lt;/files&gt;</span>
<span class="w"> </span><span class="nt">&lt;webdav&gt;</span>appinfo/remote.php<span class="nt">&lt;/webdav&gt;</span>
<span class="w"> </span><span class="nt">&lt;filesync&gt;</span>appinfo/filesync.php<span class="nt">&lt;/filesync&gt;</span>
<span class="w"> </span><span class="nt">&lt;/remote&gt;</span>
<span class="w"> </span><span class="nt">&lt;public/&gt;</span>
<span class="w"> </span><span class="nt">&lt;id&gt;</span>files<span class="nt">&lt;/id&gt;</span>
<span class="w"> </span><span class="nt">&lt;name&gt;</span>Files<span class="nt">&lt;/name&gt;</span>
<span class="w"> </span><span class="nt">&lt;description&gt;</span>File<span class="w"> </span>Management<span class="nt">&lt;/description&gt;</span>
<span class="w"> </span><span class="nt">&lt;licence&gt;</span>AGPL<span class="nt">&lt;/licence&gt;</span>
<span class="w"> </span><span class="nt">&lt;author&gt;</span>Robin<span class="w"> </span>Appelman<span class="nt">&lt;/author&gt;</span>
<span class="w"> </span><span class="nt">&lt;require&gt;</span>4.9<span class="nt">&lt;/require&gt;</span>
<span class="w"> </span><span class="nt">&lt;shipped&gt;</span>true<span class="nt">&lt;/shipped&gt;</span>
<span class="w"> </span><span class="nt">&lt;active&gt;</span>true<span class="nt">&lt;/active&gt;</span>
<span class="w"> </span><span class="nt">&lt;standalone&gt;&lt;/standalone&gt;</span>
<span class="w"> </span><span class="nt">&lt;default_enable&gt;&lt;/default_enable&gt;</span>
<span class="w"> </span><span class="nt">&lt;types&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>filesystem<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/types&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="enable-an-app">
<h2>Enable an app<a class="headerlink" href="#enable-an-app" title="Link to this heading"></a></h2>
<p>Enable an app. Authentication is done by sending a Basic HTTP Authorization
header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/apps/{appid}</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Enable the <code class="docutils literal notranslate"><span class="pre">files_texteditor</span></code> app</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="disable-an-app">
<h2>Disable an app<a class="headerlink" href="#disable-an-app" title="Link to this heading"></a></h2>
<p>Disables the specified app. Authentication is
done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/apps/{appid}</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Disable the <code class="docutils literal notranslate"><span class="pre">files_texteditor</span></code> app</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="instruction_set_for_groups.html" class="btn btn-neutral float-left" title="Instruction set for groups" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="profile_configuration.html" class="btn btn-neutral float-right" title="Profile configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/instruction_set_for_groups.html
+434
View File
@@ -0,0 +1,434 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Instruction set for groups &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Instruction set for apps" href="instruction_set_for_apps.html" />
<link rel="prev" title="Instruction set for users" href="instruction_set_for_users.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_users.html">Instruction set for users</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Instruction set for groups</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#search-get-groups">Search/get groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="#create-a-group">Create a group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-members-of-a-group">Get members of a group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-subadmins-of-a-group">Get subadmins of a group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#edit-data-of-a-single-group">Edit data of a single group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#delete-a-group">Delete a group</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_apps.html">Instruction set for apps</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html">Profile configuration</a></li>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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"><a href="user_provisioning_api.html">User provisioning API</a></li>
<li class="breadcrumb-item active">Instruction set for groups</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/instruction_set_for_groups.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="instruction-set-for-groups">
<h1>Instruction set for groups<a class="headerlink" href="#instruction-set-for-groups" title="Link to this heading"></a></h1>
<section id="search-get-groups">
<h2>Search/get groups<a class="headerlink" href="#search-get-groups" title="Link to this heading"></a></h2>
<p>Retrieves a list of groups from the Nextcloud server. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
<li><p>url arguments: search - string, optional search string</p></li>
<li><p>url arguments: limit - int, optional limit value</p></li>
<li><p>url arguments: offset - int, optional offset value</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Returns list of groups matching the search string.</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>admin<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="create-a-group">
<h2>Create a group<a class="headerlink" href="#create-a-group" title="Link to this heading"></a></h2>
<p>Adds a new group. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
<li><p>POST argument: groupid, string - the new groups name</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - invalid input data</p></li>
<li><p>102 - group already exists</p></li>
<li><p>103 - failed to add the group</p></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><span></span>$ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/groups -d groupid=&quot;newgroup&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Adds a new group called <code class="docutils literal notranslate"><span class="pre">newgroup</span></code></p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-members-of-a-group">
<h2>Get members of a group<a class="headerlink" href="#get-members-of-a-group" title="Link to this heading"></a></h2>
<p>Retrieves a list of group members. Authentication is done by sending a Basic
HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups/{groupid}</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Returns a list of users in the <code class="docutils literal notranslate"><span class="pre">admin</span></code> group</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;users&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>Frank<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/users&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-subadmins-of-a-group">
<h2>Get subadmins of a group<a class="headerlink" href="#get-subadmins-of-a-group" title="Link to this heading"></a></h2>
<p>Returns subadmins of the group. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups/{groupid}/subadmins</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - group does not exist</p></li>
<li><p>102 - unknown failure</p></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><span></span>$ curl -X GET https://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup/subadmins -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Return the subadmins of the group: <code class="docutils literal notranslate"><span class="pre">mygroup</span></code></p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>Tom<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="edit-data-of-a-single-group">
<h2>Edit data of a single group<a class="headerlink" href="#edit-data-of-a-single-group" title="Link to this heading"></a></h2>
<p>Edits attributes related to a group. Authentication
is done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups/{groupid}</strong></p>
<ul class="simple">
<li><p>HTTP method: PUT</p></li>
<li><p>PUT argument: key, string - the field to edit:</p>
<ul>
<li><p>displayname</p></li>
</ul>
</li>
<li><p>PUT argument: value, string - the new value for the field</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - not supported by backend</p></li>
</ul>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup -d key=&quot;displayname&quot; -d value=&quot;My Group Name&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Updates the display name for the group <code class="docutils literal notranslate"><span class="pre">mygroup</span></code></p></li>
</ul>
</section>
<section id="id7">
<h3>XML output<a class="headerlink" href="#id7" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="delete-a-group">
<h2>Delete a group<a class="headerlink" href="#delete-a-group" title="Link to this heading"></a></h2>
<p>Removes a group. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/groups/{groupid}</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - group does not exist</p></li>
<li><p>102 - failed to delete group</p></li>
</ul>
<section id="id8">
<h3>Example<a class="headerlink" href="#id8" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Delete the group <code class="docutils literal notranslate"><span class="pre">mygroup</span></code></p></li>
</ul>
</section>
<section id="id9">
<h3>XML output<a class="headerlink" href="#id9" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="instruction_set_for_users.html" class="btn btn-neutral float-left" title="Instruction set for users" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="instruction_set_for_apps.html" class="btn btn-neutral float-right" title="Instruction set for apps" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/instruction_set_for_users.html
+843
View File
@@ -0,0 +1,843 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Instruction set for users &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Instruction set for groups" href="instruction_set_for_groups.html" />
<link rel="prev" title="User provisioning API" href="user_provisioning_api.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Instruction set for users</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#add-a-new-user">Add a new user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#search-get-users">Search/get users</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-data-of-a-single-user">Get data of a single user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#edit-data-of-a-single-user">Edit data of a single user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#list-of-editable-data-fields">List of editable data fields</a></li>
<li class="toctree-l4"><a class="reference internal" href="#disable-a-user">Disable a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#enable-a-user">Enable a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#delete-a-user">Delete a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-user-s-groups">Get user’s groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="#add-user-to-group">Add user to group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#remove-user-from-group">Remove user from group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#promote-user-to-subadmin">Promote user to subadmin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#demote-user-from-subadmin">Demote user from subadmin</a></li>
<li class="toctree-l4"><a class="reference internal" href="#get-user-s-subadmin-groups">Get user’s subadmin groups</a></li>
<li class="toctree-l4"><a class="reference internal" href="#resend-the-welcome-email">Resend the welcome email</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_groups.html">Instruction set for groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_apps.html">Instruction set for apps</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html">Profile configuration</a></li>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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"><a href="user_provisioning_api.html">User provisioning API</a></li>
<li class="breadcrumb-item active">Instruction set for users</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/instruction_set_for_users.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="instruction-set-for-users">
<h1>Instruction set for users<a class="headerlink" href="#instruction-set-for-users" title="Link to this heading"></a></h1>
<section id="add-a-new-user">
<h2>Add a new user<a class="headerlink" href="#add-a-new-user" title="Link to this heading"></a></h2>
<p>Create a new user on the Nextcloud server. Authentication is done by sending a
basic HTTP authentication header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
<li><p>POST argument: userid - string, the required username for the new user</p></li>
<li><p>POST argument: password - string, the password for the new user, leave empty to send welcome mail</p></li>
<li><p>POST argument: displayName - string, the display name for the new user</p></li>
<li><p>POST argument: email - string, the email for the new user, required if password empty</p></li>
<li><p>POST argument: groups - array, the groups for the new user</p></li>
<li><p>POST argument: subadmin - array, the groups in which the new user is subadmin</p></li>
<li><p>POST argument: quota - string, quota for the new user</p></li>
<li><p>POST argument: language - string, language for the new user</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - invalid input data</p></li>
<li><p>102 - username already exists</p></li>
<li><p>103 - unknown error occurred whilst adding the user</p></li>
<li><p>104 - group does not exist</p></li>
<li><p>105 - insufficient privileges for group</p></li>
<li><p>106 - no group specified (required for subadmins)</p></li>
<li><p>107 - all errors that contain a hint - for example “Password is among the 1,000,000 most common ones. Please make it unique.” (this code was added in 12.0.6 &amp; 13.0.1)</p></li>
<li><p>108 - password and email empty. Must set password or an email</p></li>
<li><p>109 - invitation email cannot be send</p></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><span></span>$ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/users -d userid=&quot;Frank&quot; -d password=&quot;frankspassword&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Creates the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code> with password <code class="docutils literal notranslate"><span class="pre">frankspassword</span></code></p></li>
<li><p>optionally groups can be specified by one or more <code class="docutils literal notranslate"><span class="pre">groups[]</span></code> query parameters:
<code class="docutils literal notranslate"><span class="pre">URL</span> <span class="pre">-d</span> <span class="pre">groups[]=&quot;admin&quot;</span> <span class="pre">-D</span> <span class="pre">groups[]=&quot;Team1&quot;</span></code></p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="search-get-users">
<h2>Search/get users<a class="headerlink" href="#search-get-users" title="Link to this heading"></a></h2>
<p>Retrieves a list of users from the Nextcloud server. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
<li><p>url arguments: search - string, optional search string</p></li>
<li><p>url arguments: limit - int, optional limit value</p></li>
<li><p>url arguments: offset - int, optional offset value</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Returns list of users matching the search string.</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;users&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>Frank<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/users&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-data-of-a-single-user">
<h2>Get data of a single user<a class="headerlink" href="#get-data-of-a-single-user" title="Link to this heading"></a></h2>
<p>Retrieves information about a single user. Authentication is done by sending a
Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></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><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Returns information on the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;enabled&gt;</span>true<span class="nt">&lt;/enabled&gt;</span>
<span class="w"> </span><span class="nt">&lt;id&gt;</span>Frank<span class="nt">&lt;/id&gt;</span>
<span class="w"> </span><span class="nt">&lt;quota&gt;</span>0<span class="nt">&lt;/quota&gt;</span>
<span class="w"> </span><span class="nt">&lt;email&gt;</span>frank@example.org<span class="nt">&lt;/email&gt;</span>
<span class="w"> </span><span class="nt">&lt;displayname&gt;</span>Frank<span class="w"> </span>K.<span class="nt">&lt;/displayname&gt;</span>
<span class="w"> </span><span class="nt">&lt;display-name&gt;</span>Frank<span class="w"> </span>K.<span class="nt">&lt;/display-name&gt;</span>
<span class="w"> </span><span class="nt">&lt;phone&gt;</span>0123<span class="w"> </span>/<span class="w"> </span>456<span class="w"> </span>789<span class="nt">&lt;/phone&gt;</span>
<span class="w"> </span><span class="nt">&lt;address&gt;</span>Foobar<span class="w"> </span>12,<span class="w"> </span>12345<span class="w"> </span>Town<span class="nt">&lt;/address&gt;</span>
<span class="w"> </span><span class="nt">&lt;website&gt;</span>https://nextcloud.com<span class="nt">&lt;/website&gt;</span>
<span class="w"> </span><span class="nt">&lt;twitter&gt;</span>Nextcloud<span class="nt">&lt;/twitter&gt;</span>
<span class="w"> </span><span class="nt">&lt;groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>group1<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>group2<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="edit-data-of-a-single-user">
<h2>Edit data of a single user<a class="headerlink" href="#edit-data-of-a-single-user" title="Link to this heading"></a></h2>
<p>Edits attributes related to a user. Users are able to edit email, displayname
and password; admins can also edit the quota value. Further restrictions may apply,
check the <a class="reference internal" href="#list-of-editable-data-fields">List of editable data fields</a> endpoint. Authentication
is done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}</strong></p>
<ul class="simple">
<li><p>HTTP method: PUT</p></li>
<li><p>PUT argument: key, the field to edit:</p>
<ul>
<li><p>email</p></li>
<li><p>quota</p></li>
<li><p>displayname</p></li>
<li><p>display (<strong>deprecated</strong> use <cite>displayname</cite> instead)</p></li>
<li><p>phone</p></li>
<li><p>address</p></li>
<li><p>website</p></li>
<li><p>twitter</p></li>
<li><p>password</p></li>
</ul>
</li>
<li><p>PUT argument: value, the new value for the field</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - user not found</p></li>
<li><p>102 - invalid input data</p></li>
</ul>
<section id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d key=&quot;email&quot; -d value=&quot;franksnewemail@example.org&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Updates the email address for the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d key=&quot;quota&quot; -d value=&quot;100MB&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Updates the quota for the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
</section>
<section id="id5">
<h3>XML output<a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="list-of-editable-data-fields">
<span id="editable-field-list"></span><h2>List of editable data fields<a class="headerlink" href="#list-of-editable-data-fields" title="Link to this heading"></a></h2>
<p>Edits attributes related to a user. Users are able to edit email, displayname
and password; admins can also edit the quota value. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/user/fields</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
</ul>
<section id="id6">
<h3>Examples<a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/user/fields -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Gets the list of fields</p></li>
</ul>
</section>
<section id="id7">
<h3>XML output<a class="headerlink" href="#id7" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message&gt;</span>OK<span class="nt">&lt;/message&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>displayname<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>email<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>phone<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>address<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>website<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>twitter<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="disable-a-user">
<h2>Disable a user<a class="headerlink" href="#disable-a-user" title="Link to this heading"></a></h2>
<p>Disables a user on the Nextcloud server so that the user cannot login anymore.
Authentication is done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/disable</strong></p>
<ul class="simple">
<li><p>HTTP method: PUT</p></li>
</ul>
<p>Statuscodes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - failure</p></li>
</ul>
<section id="id8">
<h3>Example<a class="headerlink" href="#id8" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Disables the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
</section>
<section id="id9">
<h3>XML output<a class="headerlink" href="#id9" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="enable-a-user">
<h2>Enable a user<a class="headerlink" href="#enable-a-user" title="Link to this heading"></a></h2>
<p>Enables a user on the Nextcloud server so that the user can login again.
Authentication is done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/enable</strong></p>
<ul class="simple">
<li><p>HTTP method: PUT</p></li>
</ul>
<p>Statuscodes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - failure</p></li>
</ul>
<section id="id10">
<h3>Example<a class="headerlink" href="#id10" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Enables the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
</section>
<section id="id11">
<h3>XML output<a class="headerlink" href="#id11" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="delete-a-user">
<h2>Delete a user<a class="headerlink" href="#delete-a-user" title="Link to this heading"></a></h2>
<p>Deletes a user from the Nextcloud server. Authentication is done by sending a
Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></li>
</ul>
<p>Statuscodes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - failure</p></li>
</ul>
<section id="id12">
<h3>Example<a class="headerlink" href="#id12" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Deletes the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
</section>
<section id="id13">
<h3>XML output<a class="headerlink" href="#id13" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-user-s-groups">
<h2>Get user’s groups<a class="headerlink" href="#get-user-s-groups" title="Link to this heading"></a></h2>
<p>Retrieves a list of groups the specified user is a member of. Authentication is
done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/groups</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
</ul>
<section id="id14">
<h3>Example<a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Retrieves a list of groups of which <code class="docutils literal notranslate"><span class="pre">Frank</span></code> is a member</p></li>
</ul>
</section>
<section id="id15">
<h3>XML output<a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>admin<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>group1<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/groups&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="add-user-to-group">
<h2>Add user to group<a class="headerlink" href="#add-user-to-group" title="Link to this heading"></a></h2>
<p>Adds the specified user to the specified group. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/groups</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
<li><p>POST argument: groupid, string - the group to add the user to</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - no group specified</p></li>
<li><p>102 - group does not exist</p></li>
<li><p>103 - user does not exist</p></li>
<li><p>104 - insufficient privileges</p></li>
<li><p>105 - failed to add user to group</p></li>
</ul>
<section id="id16">
<h3>Example<a class="headerlink" href="#id16" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid=&quot;newgroup&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Adds the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code> to the group <code class="docutils literal notranslate"><span class="pre">newgroup</span></code></p></li>
</ul>
</section>
<section id="id17">
<h3>XML output<a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="remove-user-from-group">
<h2>Remove user from group<a class="headerlink" href="#remove-user-from-group" title="Link to this heading"></a></h2>
<p>Removes the specified user from the specified group. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/groups</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></li>
<li><p>DELETE argument: groupid, string - the group to remove the user from</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - no group specified</p></li>
<li><p>102 - group does not exist</p></li>
<li><p>103 - user does not exist</p></li>
<li><p>104 - insufficient privileges</p></li>
<li><p>105 - failed to remove user from group</p></li>
</ul>
<section id="id18">
<h3>Example<a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid=&quot;newgroup&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Removes the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code> from the group <code class="docutils literal notranslate"><span class="pre">newgroup</span></code></p></li>
</ul>
</section>
<section id="id19">
<h3>XML output<a class="headerlink" href="#id19" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="promote-user-to-subadmin">
<h2>Promote user to subadmin<a class="headerlink" href="#promote-user-to-subadmin" title="Link to this heading"></a></h2>
<p>Makes a user the subadmin of a group. Authentication is done by sending a Basic
HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/subadmins</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
<li><p>POST argument: groupid, string - the group of which to make the user a
subadmin</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - user does not exist</p></li>
<li><p>102 - group does not exist</p></li>
<li><p>103 - unknown failure</p></li>
</ul>
<section id="id20">
<h3>Example<a class="headerlink" href="#id20" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X POST https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins -d groupid=&quot;group&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Makes the user <code class="docutils literal notranslate"><span class="pre">Frank</span></code> a subadmin of the <code class="docutils literal notranslate"><span class="pre">group</span></code> group</p></li>
</ul>
</section>
<section id="id21">
<h3>XML output<a class="headerlink" href="#id21" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="demote-user-from-subadmin">
<h2>Demote user from subadmin<a class="headerlink" href="#demote-user-from-subadmin" title="Link to this heading"></a></h2>
<p>Removes the subadmin rights for the user specified from the group specified.
Authentication is done by sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/subadmins</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></li>
<li><p>DELETE argument: groupid, string - the group from which to remove the user’s
subadmin rights</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - user does not exist</p></li>
<li><p>102 - user is not a subadmin of the group / group does not exist</p></li>
<li><p>103 - unknown failure</p></li>
</ul>
<section id="id22">
<h3>Example<a class="headerlink" href="#id22" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X DELETE https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins -d groupid=&quot;oldgroup&quot; -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Removes <code class="docutils literal notranslate"><span class="pre">Frank's</span></code> subadmin rights from the <code class="docutils literal notranslate"><span class="pre">oldgroup</span></code> group</p></li>
</ul>
</section>
<section id="id23">
<h3>XML output<a class="headerlink" href="#id23" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="get-user-s-subadmin-groups">
<h2>Get user’s subadmin groups<a class="headerlink" href="#get-user-s-subadmin-groups" title="Link to this heading"></a></h2>
<p>Returns the groups in which the user is a subadmin. Authentication is done by
sending a Basic HTTP Authorization header.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/subadmins</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - user does not exist</p></li>
<li><p>102 - unknown failure</p></li>
</ul>
<section id="id24">
<h3>Example<a class="headerlink" href="#id24" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X GET https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Returns the groups of which <code class="docutils literal notranslate"><span class="pre">Frank</span></code> is a subadmin</p></li>
</ul>
</section>
<section id="id25">
<h3>XML output<a class="headerlink" href="#id25" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;element&gt;</span>testgroup<span class="nt">&lt;/element&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
<section id="resend-the-welcome-email">
<h2>Resend the welcome email<a class="headerlink" href="#resend-the-welcome-email" title="Link to this heading"></a></h2>
<p>The request to this endpoint triggers the welcome email for this user again.</p>
<p><strong>Syntax: ocs/v1.php/cloud/users/{userid}/welcome</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></li>
</ul>
<p>Status codes:</p>
<ul class="simple">
<li><p>100 - successful</p></li>
<li><p>101 - email address not available</p></li>
<li><p>102 - sending email failed</p></li>
</ul>
<section id="id26">
<h3>Example<a class="headerlink" href="#id26" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -X POST https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/welcome -H &quot;OCS-APIRequest: true&quot;
</pre></div>
</div>
<ul class="simple">
<li><p>Sends the welcome email to <code class="docutils literal notranslate"><span class="pre">Frank</span></code></p></li>
</ul>
</section>
<section id="id27">
<h3>XML output<a class="headerlink" href="#id27" title="Link to this heading"></a></h3>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>100<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message/&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</pre></div>
</div>
</section>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_provisioning_api.html" class="btn btn-neutral float-left" title="User provisioning API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="instruction_set_for_groups.html" class="btn btn-neutral float-right" title="Instruction set for groups" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/profile_configuration.html
+283
View File
@@ -0,0 +1,283 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Profile configuration &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="File sharing and management" href="../configuration_files/index.html" />
<link rel="prev" title="Instruction set for apps" href="instruction_set_for_apps.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_provisioning_api.html">User provisioning API</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Profile configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#property-scopes">Property scopes</a></li>
</ul>
</li>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">Profile configuration</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/profile_configuration.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="profile-configuration">
<span id="profile"></span><h1>Profile configuration<a class="headerlink" href="#profile-configuration" title="Link to this heading"></a></h1>
<p>The user profile presents the information of a user and is enabled by default
for all users. Users may individually enable or disable their profile in their
Personal info settings under the Personal settings section.</p>
<p>As an administrator you may change the default for new users and may also
disable profile globally to remove all profile functionality.</p>
<p>Profile properties are also written into the <a class="reference internal" href="../groupware/contacts.html#system-address-book"><span class="std std-ref">system address book</span></a>.</p>
<p>To enable or disable profile by default for new users switch the toggle in
Basic settings under the Administration settings section.</p>
<figure class="align-default">
<img alt="../_images/profile_default_setting.png" src="../_images/profile_default_setting.png" />
</figure>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you are upgrading from Nextcloud 22 to 23 and want profile to
be disabled by default for all users, you may run the <code class="docutils literal notranslate"><span class="pre">occ</span></code> command below
before upgrading or upgrade first then switch the toggle in Basic settings
before letting any users log in.</p>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">settings</span> <span class="n">profile_enabled_by_default</span> <span class="o">--</span><span class="n">value</span><span class="o">=</span><span class="s2">&quot;0&quot;</span>
</pre></div>
</div>
<p>Please refer to <a class="reference internal" href="../configuration_server/occ_command.html"><span class="doc">Using the occ command</span></a> for all available
<code class="docutils literal notranslate"><span class="pre">occ</span></code> commands.</p>
<p>To disable profile globally add the following line to your <code class="docutils literal notranslate"><span class="pre">config.php</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">&#39;profile.enabled&#39;</span> <span class="o">=&gt;</span> <span class="n">false</span><span class="p">,</span>
</pre></div>
</div>
<p>Please refer to <a class="reference internal" href="../configuration_server/config_sample_php_parameters.html"><span class="doc">Configuration Parameters</span></a> for
all available <code class="docutils literal notranslate"><span class="pre">config.php</span></code> options.</p>
<section id="property-scopes">
<span id="profile-property-scopes"></span><h2>Property scopes<a class="headerlink" href="#property-scopes" title="Link to this heading"></a></h2>
<p>User properties (Full name, Address, Website, Role, …) have specific visibility scopes (Private, Local, Federated, Published).</p>
<p>The visibility scopes are explained below:</p>
<dl class="field-list simple">
<dt class="field-odd">Private<span class="colon">:</span></dt>
<dd class="field-odd"><p>Contact details visible locally only</p>
</dd>
<dt class="field-even">Local<span class="colon">:</span></dt>
<dd class="field-even"><p>Contact details visible locally and through public link access on local instance</p>
</dd>
<dt class="field-odd">Federated<span class="colon">:</span></dt>
<dd class="field-odd"><p>Contact details visible locally, through public link access and on trusted federated servers.</p>
</dd>
<dt class="field-even">Published<span class="colon">:</span></dt>
<dd class="field-even"><p>Contact details visible locally, through public link access, on trusted federated servers and published to the public lookup server.</p>
</dd>
</dl>
<p>The default values for each property for each new user is listed below, but you should consult the declaration of the <code class="docutils literal notranslate"><span class="pre">DEFAULT_SCOPES</span></code> constant in the <code class="docutils literal notranslate"><span class="pre">OC\Accounts\AccountManager</span></code> class (<a class="reference external" href="https://github.com/nextcloud/server/blob/master/lib/private/Accounts/AccountManager.php">see the code</a>) to make sure these are up-to-date.</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Property</p></th>
<th class="head"><p>Default visibility scope</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Full name</p></td>
<td><p>Federated</p></td>
</tr>
<tr class="row-odd"><td><p>Address</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-even"><td><p>Website</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-odd"><td><p>Email</p></td>
<td><p>Federated</p></td>
</tr>
<tr class="row-even"><td><p>Avatar</p></td>
<td><p>Federated</p></td>
</tr>
<tr class="row-odd"><td><p>Phone</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-even"><td><p>Twitter</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-odd"><td><p>Organisation</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-even"><td><p>Role</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-odd"><td><p>Headline</p></td>
<td><p>Local</p></td>
</tr>
<tr class="row-even"><td><p>Biography</p></td>
<td><p>Local</p></td>
</tr>
</tbody>
</table>
<p>If you’d like to override the value for one or several default visibility scopes, use the <code class="docutils literal notranslate"><span class="pre">account_manager.default_property_scope</span></code> <code class="docutils literal notranslate"><span class="pre">config.php</span></code> configuration key, which defaults to an empty array:</p>
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">&#39;account_manager.default_property_scope&#39; =&gt; [</span>
<span class="x"> \OCP\Accounts\IAccountManager::PROPERTY_PHONE =&gt; \OCP\Accounts\IAccountManager::SCOPE_PRIVATE,</span>
<span class="x"> \OCP\Accounts\IAccountManager::PROPERTY_ROLE =&gt; \OCP\Accounts\IAccountManager::SCOPE_FEDERATED</span>
<span class="x">]</span>
</pre></div>
</div>
<p>In the above example, the phone and role properties are respectively overwritten to the private and federated scopes. Note that these changes will only apply to <em>new</em> users, not existing ones.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="instruction_set_for_apps.html" class="btn btn-neutral float-left" title="Instruction set for apps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../configuration_files/index.html" class="btn btn-neutral float-right" title="File sharing and management" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/reset_admin_password.html
+200
View File
@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Resetting a lost admin password &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Resetting a user password" href="reset_user_password.html" />
<link rel="prev" title="User management" href="user_configuration.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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 current"><a class="current reference internal" href="#">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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">Resetting a lost admin password</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/reset_admin_password.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="resetting-a-lost-admin-password">
<h1>Resetting a lost admin password<a class="headerlink" href="#resetting-a-lost-admin-password" title="Link to this heading"></a></h1>
<p>The normal ways to recover a lost password are:</p>
<ol class="arabic simple">
<li><p>Click the password reset link on the login screen; this appears after a
failed login attempt. This works only if you have entered your email address
on your Personal page in the Nextcloud Web interface, so that the Nextcloud
server can email a reset link to you.</p></li>
<li><p>Ask another Nextcloud server admin to reset it for you.</p></li>
</ol>
<p>If neither of these is an option, then you have a third option, and that is
using the <code class="docutils literal notranslate"><span class="pre">occ</span></code> command. See <a class="reference internal" href="../configuration_server/occ_command.html"><span class="doc">Using the occ command</span></a> to
learn more about using the <code class="docutils literal notranslate"><span class="pre">occ</span></code> command.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo -u www-data php /var/www/nextcloud/occ user:resetpassword admin
Enter a new password:
Confirm the new password:
Successfully reset password for admin
</pre></div>
</div>
<p>If your Nextcloud username is not <code class="docutils literal notranslate"><span class="pre">admin</span></code>, then substitute your Nextcloud
username.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_configuration.html" class="btn btn-neutral float-left" title="User management" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="reset_user_password.html" class="btn btn-neutral float-right" title="Resetting a user password" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/reset_user_password.html
+190
View File
@@ -0,0 +1,190 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Resetting a user password &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="User password policy" href="user_password_policy.html" />
<link rel="prev" title="Resetting a lost admin password" href="reset_admin_password.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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 current"><a class="current reference internal" href="#">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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">Resetting a user password</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/reset_user_password.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="resetting-a-user-password">
<h1>Resetting a user password<a class="headerlink" href="#resetting-a-user-password" title="Link to this heading"></a></h1>
<p>The Nextcloud login screen displays a <strong>Wrong password. Reset it?</strong> message
after a user enters an incorrect password, and then Nextcloud automatically
resets their password. However, if you are using a read-only authentication
backend such as LDAP or Active Directory, this will not work. In this case you
may specify a custom URL in your <code class="docutils literal notranslate"><span class="pre">config.php</span></code> file to direct your user to a
server than can handle an automatic reset:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">&#39;lost_password_link&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;https://example.org/link/to/password/reset&#39;</span><span class="p">,</span>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="reset_admin_password.html" class="btn btn-neutral float-left" title="Resetting a lost admin password" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_password_policy.html" class="btn btn-neutral float-right" title="User password policy" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/two_factor-auth.html
+222
View File
@@ -0,0 +1,222 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Two-factor authentication &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="User authentication with IMAP, SMB, FTP and others" href="user_auth_ftp_smb_imap.html" />
<link rel="prev" title="User password policy" href="user_password_policy.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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 current"><a class="current reference internal" href="#">Two-factor authentication</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#enabling-two-factor-authentication">Enabling two-factor authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enforcing-two-factor-authentication">Enforcing two-factor authentication</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">Two-factor authentication</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/two_factor-auth.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="two-factor-authentication">
<h1>Two-factor authentication<a class="headerlink" href="#two-factor-authentication" title="Link to this heading"></a></h1>
<p>Two-factor authentication adds an additional layer of security to user accounts. In order to log
in on an account with two-factor authentication (2FA) enabled, it is necessary to provide both the
login password and another factor. 2FA in Nextcloud is pluggable, meaning that they are not part
of the Nextcloud Server component but provided by featured and 3rd-party Nextcloud apps.</p>
<p>Several 2FA apps are already available including
<a class="reference external" href="https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm">TOTP</a>,
a Telegram/Signal/SMS gateway and <a class="reference external" href="https://en.wikipedia.org/wiki/Universal_2nd_Factor">U2F</a>.</p>
<p>Developers can <a class="reference external" href="https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/two-factor-provider.html">build new two-factor provider apps</a>.</p>
<section id="enabling-two-factor-authentication">
<h2>Enabling two-factor authentication<a class="headerlink" href="#enabling-two-factor-authentication" title="Link to this heading"></a></h2>
<p>You can enable 2FA by installing and enabling a 2FA app like TOTP which works
with Google Authenticator and compatible apps. The apps are available in the
Nextcloud App store so by navigating there and clicking <strong>enable</strong> for the app
you want, 2FA will be installed and enabled on your Nextcloud server.</p>
<figure class="align-default">
<img alt="../_images/2fa-app-install.png" src="../_images/2fa-app-install.png" />
</figure>
<p>Once 2FA has been enabled, users have to <a class="reference external" href="https://docs.nextcloud.com/server/latest/user_manual/en/user_2fa.html">activate it in their personal settings.</a></p>
</section>
<section id="enforcing-two-factor-authentication">
<h2>Enforcing two-factor authentication<a class="headerlink" href="#enforcing-two-factor-authentication" title="Link to this heading"></a></h2>
<p>By default 2FA is <em>optional</em>, hence users are given the choice whether to enable
it for their account. Admins may enforce the use of 2FA.</p>
<p>Enforcement is possible system-wide (all users), for selected groups only and can
also be excluded for certain groups.</p>
<p>These settings can be found in the administrator’s security settings.</p>
<figure class="align-default">
<img alt="../_images/2fa-admin-settings.png" src="../_images/2fa-admin-settings.png" />
</figure>
<p>When groups are selected/excluded, they use the following logic to determine if
a user has 2FA enforced:</p>
<ul class="simple">
<li><p>If no groups are selected, 2FA is enabled for everyone except members of the excluded groups</p></li>
<li><p>If groups are selected, 2FA is enabled for all members of these. If a user is both in a
selected <em>and</em> excluded group, the selected takes precedence and 2FA is enforced.</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_password_policy.html" class="btn btn-neutral float-left" title="User password policy" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_auth_ftp_smb_imap.html" class="btn btn-neutral float-right" title="User authentication with IMAP, SMB, FTP and others" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_auth_ftp_smb_imap.html
+185
View File
@@ -0,0 +1,185 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User authentication with IMAP, SMB, FTP and others &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="User authentication with LDAP" href="user_auth_ldap.html" />
<link rel="prev" title="Two-factor authentication" href="two_factor-auth.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">User authentication with IMAP, SMB, FTP and others</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_auth_ftp_smb_imap.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="user-authentication-with-imap-smb-ftp-and-others">
<h1>User authentication with IMAP, SMB, FTP and others<a class="headerlink" href="#user-authentication-with-imap-smb-ftp-and-others" title="Link to this heading"></a></h1>
<p>You may configure additional user backends with the
External User Backends (user_external) app.</p>
<p>See <a class="reference external" href="https://github.com/nextcloud/user_external#readme">https://github.com/nextcloud/user_external#readme</a>
for an up to date documentation.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="two_factor-auth.html" class="btn btn-neutral float-left" title="Two-factor authentication" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_auth_ldap.html" class="btn btn-neutral float-right" title="User authentication with LDAP" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_auth_ldap.html
+1094
View File
File diff suppressed because it is too large Load Diff
wedding-pics/core/doc/admin/configuration_user/user_auth_ldap_api.html
+683
View File
@@ -0,0 +1,683 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>The LDAP configuration API &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="User provisioning API" href="user_provisioning_api.html" />
<link rel="prev" title="LDAP user cleanup" href="user_auth_ldap_cleanup.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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>
<p>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”.</p>
<section id="creating-a-configuration">
<h2>Creating a configuration<a class="headerlink" href="#creating-a-configuration" title="Link to this heading"></a></h2>
<p>Creates a new and empty LDAP configuration. It returns its ID. Authentication is done by sending a
basic HTTP authentication header.</p>
<p><strong>Syntax: ocs/v2.php/apps/user_ldap/api/v1/config</strong></p>
<ul class="simple">
<li><p>HTTP method: POST</p></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><span></span>$ 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><p>Creates a new, empty configuration</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>200<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message&gt;</span>OK<span class="nt">&lt;/message&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;configID&gt;</span>s01<span class="nt">&lt;/configID&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</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>
<p>Deletes a given LDAP configuration. Authentication is done by sending a basic HTTP authentication header.</p>
<p><strong>Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}</strong></p>
<ul class="simple">
<li><p>HTTP method: DELETE</p></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><span></span>$ 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><p>deletes the LDAP configuration</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>200<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message&gt;</span>OK<span class="nt">&lt;/message&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</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>
<p>Returns all keys and values of the specified LDAP configuration. Authentication is done by sending a basic HTTP authentication header.</p>
<p><strong>Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}</strong></p>
<ul class="simple">
<li><p>HTTP method: GET</p></li>
<li><p>url argument: showPassword - int, optional, default 0, whether to return the password in clear text</p></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><span></span>$ 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><p>fetches the LDAP configuration</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>200<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message&gt;</span>OK<span class="nt">&lt;/message&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapHost&gt;</span>ldap://ldap.server.tld<span class="nt">&lt;/ldapHost&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapPort&gt;</span>389<span class="nt">&lt;/ldapPort&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapBackupHost&gt;&lt;/ldapBackupHost&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapBackupPort&gt;&lt;/ldapBackupPort&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapBase&gt;</span>ou=Department<span class="w"> </span>XLII,dc=example,dc=com<span class="nt">&lt;/ldapBase&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapBaseUsers&gt;</span>ou=users,ou=Department<span class="w"> </span>XLII,dc=example,dc=com<span class="nt">&lt;/ldapBaseUsers&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapBaseGroups&gt;</span>ou=Department<span class="w"> </span>XLII,dc=example,dc=com<span class="nt">&lt;/ldapBaseGroups&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapAgentName&gt;</span>cn=root,dc=example,dc=com<span class="nt">&lt;/ldapAgentName&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapAgentPassword&gt;</span>Secret<span class="nt">&lt;/ldapAgentPassword&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapTLS&gt;</span>1<span class="nt">&lt;/ldapTLS&gt;</span>
<span class="w"> </span><span class="nt">&lt;turnOffCertCheck&gt;</span>0<span class="nt">&lt;/turnOffCertCheck&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapIgnoreNamingRules/&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserDisplayName&gt;</span>displayname<span class="nt">&lt;/ldapUserDisplayName&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserDisplayName2&gt;</span>uid<span class="nt">&lt;/ldapUserDisplayName2&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGidNumber&gt;</span>gidNumber<span class="nt">&lt;/ldapGidNumber&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserFilterObjectclass&gt;</span>inetOrgPerson<span class="nt">&lt;/ldapUserFilterObjectclass&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserFilterGroups&gt;&lt;/ldapUserFilterGroups&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserFilter&gt;</span>(<span class="ni">&amp;amp;</span>(objectclass=nextcloudUser)(nextcloudEnabled=TRUE))<span class="nt">&lt;/ldapUserFilter&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUserFilterMode&gt;</span>1<span class="nt">&lt;/ldapUserFilterMode&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupFilter&gt;</span>(<span class="ni">&amp;amp;</span>(|(objectclass=nextcloudGroup)))<span class="nt">&lt;/ldapGroupFilter&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupFilterMode&gt;</span>0<span class="nt">&lt;/ldapGroupFilterMode&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupFilterObjectclass&gt;</span>nextcloudGroup<span class="nt">&lt;/ldapGroupFilterObjectclass&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupFilterGroups&gt;&lt;/ldapGroupFilterGroups&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupMemberAssocAttr&gt;</span>memberUid<span class="nt">&lt;/ldapGroupMemberAssocAttr&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapGroupDisplayName&gt;</span>cn<span class="nt">&lt;/ldapGroupDisplayName&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapLoginFilter&gt;</span>(<span class="ni">&amp;amp;</span>(|(objectclass=inetOrgPerson))(uid=%uid))<span class="nt">&lt;/ldapLoginFilter&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapLoginFilterMode&gt;</span>0<span class="nt">&lt;/ldapLoginFilterMode&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapLoginFilterEmail&gt;</span>0<span class="nt">&lt;/ldapLoginFilterEmail&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapLoginFilterUsername&gt;</span>1<span class="nt">&lt;/ldapLoginFilterUsername&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapLoginFilterAttributes&gt;&lt;/ldapLoginFilterAttributes&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapQuotaAttribute&gt;&lt;/ldapQuotaAttribute&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapQuotaDefault&gt;</span>20<span class="w"> </span>MB<span class="nt">&lt;/ldapQuotaDefault&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapEmailAttribute&gt;</span>mail<span class="nt">&lt;/ldapEmailAttribute&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapCacheTTL&gt;</span>600<span class="nt">&lt;/ldapCacheTTL&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUuidUserAttribute&gt;</span>auto<span class="nt">&lt;/ldapUuidUserAttribute&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapUuidGroupAttribute&gt;</span>auto<span class="nt">&lt;/ldapUuidGroupAttribute&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapOverrideMainServer&gt;&lt;/ldapOverrideMainServer&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapConfigurationActive&gt;</span>1<span class="nt">&lt;/ldapConfigurationActive&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapAttributesForUserSearch&gt;</span>uid;sn;givenname<span class="nt">&lt;/ldapAttributesForUserSearch&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapAttributesForGroupSearch&gt;&lt;/ldapAttributesForGroupSearch&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapExperiencedAdmin&gt;</span>0<span class="nt">&lt;/ldapExperiencedAdmin&gt;</span>
<span class="w"> </span><span class="nt">&lt;homeFolderNamingRule&gt;</span>attr:mail<span class="nt">&lt;/homeFolderNamingRule&gt;</span>
<span class="w"> </span><span class="nt">&lt;hasPagedResultSupport&gt;&lt;/hasPagedResultSupport&gt;</span>
<span class="w"> </span><span class="nt">&lt;hasMemberOfFilterSupport&gt;</span>1<span class="nt">&lt;/hasMemberOfFilterSupport&gt;</span>
<span class="w"> </span><span class="nt">&lt;useMemberOfToDetectMembership&gt;</span>1<span class="nt">&lt;/useMemberOfToDetectMembership&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapExpertUsernameAttr&gt;&lt;/ldapExpertUsernameAttr&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapExpertUUIDUserAttr&gt;&lt;/ldapExpertUUIDUserAttr&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapExpertUUIDGroupAttr&gt;&lt;/ldapExpertUUIDGroupAttr&gt;</span>
<span class="w"> </span><span class="nt">&lt;lastJpegPhotoLookup&gt;</span>0<span class="nt">&lt;/lastJpegPhotoLookup&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapNestedGroups&gt;</span>0<span class="nt">&lt;/ldapNestedGroups&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapPagingSize&gt;</span>500<span class="nt">&lt;/ldapPagingSize&gt;</span>
<span class="w"> </span><span class="nt">&lt;turnOnPasswordChange&gt;</span>1<span class="nt">&lt;/turnOnPasswordChange&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapDynamicGroupMemberURL&gt;&lt;/ldapDynamicGroupMemberURL&gt;</span>
<span class="w"> </span><span class="nt">&lt;ldapDefaultPPolicyDN&gt;&lt;/ldapDefaultPPolicyDN&gt;</span>
<span class="w"> </span><span class="nt">&lt;/data&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</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>
<p>Updates a configuration with the provided values. Authentication is done by sending a basic HTTP authentication header.</p>
<p><strong>Syntax: ocs/v2.php/apps/user_ldap/api/v1/config/{configID}</strong></p>
<ul class="simple">
<li><p>HTTP method: PUT</p></li>
<li><p>url argument: configData - array, see table below for the fields. All fields are optional. The values must be url-encoded.</p></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><span></span>$ 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><p>updates the LDAP configuration</p></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><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot;?&gt;</span>
<span class="nt">&lt;ocs&gt;</span>
<span class="w"> </span><span class="nt">&lt;meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;status&gt;</span>ok<span class="nt">&lt;/status&gt;</span>
<span class="w"> </span><span class="nt">&lt;statuscode&gt;</span>200<span class="nt">&lt;/statuscode&gt;</span>
<span class="w"> </span><span class="nt">&lt;message&gt;</span>OK<span class="nt">&lt;/message&gt;</span>
<span class="w"> </span><span class="nt">&lt;/meta&gt;</span>
<span class="w"> </span><span class="nt">&lt;data/&gt;</span>
<span class="nt">&lt;/ocs&gt;</span>
</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"><p>Key</p></th>
<th class="head"><p>Mode</p></th>
<th class="head"><p>Required</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>ldapHost</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>LDAP server host, supports protocol</p></td>
</tr>
<tr class="row-odd"><td><p>ldapPort</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>LDAP server port</p></td>
</tr>
<tr class="row-even"><td><p>ldapBackupHost</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP replica host</p></td>
</tr>
<tr class="row-odd"><td><p>ldapBackupPort</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP replica port</p></td>
</tr>
<tr class="row-even"><td><p>ldapOverrideMainServer</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Whether replica should be used instead</p></td>
</tr>
<tr class="row-odd"><td><p>ldapBase</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>Base</p></td>
</tr>
<tr class="row-even"><td><p>ldapBaseUsers</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Base for users, defaults to general base if not specified</p></td>
</tr>
<tr class="row-odd"><td><p>ldapBaseGroups</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Base for groups, defaults to general base if not specified</p></td>
</tr>
<tr class="row-even"><td><p>ldapAgentName</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>DN for the (service) user to connect to LDAP</p></td>
</tr>
<tr class="row-odd"><td><p>ldapAgentPassword</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Password for the service user</p></td>
</tr>
<tr class="row-even"><td><p>ldapTLS</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Whether to use StartTLS</p></td>
</tr>
<tr class="row-odd"><td><p>turnOffCertCheck</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Turns off certificate validation for TLS connections</p></td>
</tr>
<tr class="row-even"><td><p>ldapIgnoreNamingRules</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Backwards compatibility, do not set it.</p></td>
</tr>
<tr class="row-odd"><td><p>ldapUserDisplayName</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>Attribute used as display name for users</p></td>
</tr>
<tr class="row-even"><td><p>ldapUserDisplayName2</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Additional attribute, if set show on brackets next to the main attribute</p></td>
</tr>
<tr class="row-odd"><td><p>ldapUserAvatarRule</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Specify the avatar integration behavior, possible values: “default”, “none”, “<a class="reference external" href="data:$ATTRIBUTENAME">data:$ATTRIBUTENAME</a>”</p></td>
</tr>
<tr class="row-even"><td><p>ldapGidNumber</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>group ID attribute, needed for primary groups on OpenLDAP (and compatible)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapUserFilterObjectclass</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-even"><td><p>ldapUserFilterGroups</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapUserFilter</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>LDAP Filter used to retrieve user</p></td>
</tr>
<tr class="row-even"><td><p>ldapUserFilterMode</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>used by the Settings Wizard, set to 1 for manual editing</p></td>
</tr>
<tr class="row-odd"><td><p>ldapAttributesForUserSearch</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>attributes to be matched when searching for users. separate by ;</p></td>
</tr>
<tr class="row-even"><td><p>ldapGroupFilter</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP Filter used to retrieve groups</p></td>
</tr>
<tr class="row-odd"><td><p>ldapGroupFilterMode</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>used by the Settings Wizard, set to 1 for manual editing</p></td>
</tr>
<tr class="row-even"><td><p>ldapGroupFilterObjectclass</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapGroupFilterGroups</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-even"><td><p>ldapGroupMemberAssocAttr</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>attribute that indicates group members, one of: member, memberUid, uniqueMember, gidNumber</p></td>
</tr>
<tr class="row-odd"><td><p>ldapGroupDisplayName</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Attribute used as display name for groups, required if groups are used</p></td>
</tr>
<tr class="row-even"><td><p>ldapAttributesForGroupSearch</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>attributes to be matched when searching for groups. separate by ;</p></td>
</tr>
<tr class="row-odd"><td><p>ldapLoginFilter</p></td>
<td><p>rw</p></td>
<td><p>yes</p></td>
<td><p>LDAP Filter used to authenticate users</p></td>
</tr>
<tr class="row-even"><td><p>ldapLoginFilterMode</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>used by the Settings Wizard, set to 1 for manual editing</p></td>
</tr>
<tr class="row-odd"><td><p>ldapLoginFilterEmail</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-even"><td><p>ldapLoginFilterUsername</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapLoginFilterAttributes</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>set by the Settings Wizard (web UI)</p></td>
</tr>
<tr class="row-even"><td><p>ldapQuotaAttribute</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP attribute containing the quote value (per user)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapQuotaDefault</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Default Quota, if specified quota attribute is empty</p></td>
</tr>
<tr class="row-even"><td><p>ldapEmailAttribute</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP attribute containing the email address (takes first if multiple are stored)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapCacheTTL</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>How long results from LDAP are cached, defaults to 10min</p></td>
</tr>
<tr class="row-even"><td><p>ldapUuidUserAttribute</p></td>
<td><p>r</p></td>
<td><p>no</p></td>
<td><p>set in runtime</p></td>
</tr>
<tr class="row-odd"><td><p>ldapUuidGroupAttribute</p></td>
<td><p>r</p></td>
<td><p>no</p></td>
<td><p>set in runtime</p></td>
</tr>
<tr class="row-even"><td><p>ldapConfigurationActive</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>whether this configuration is active. 1 is on, 0 is off.</p></td>
</tr>
<tr class="row-odd"><td><p>ldapExperiencedAdmin</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>used by the Settings Wizard, set to 1 for manual editing</p></td>
</tr>
<tr class="row-even"><td><p>homeFolderNamingRule</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP attribute to use a user folder name</p></td>
</tr>
<tr class="row-odd"><td><p>hasPagedResultSupport</p></td>
<td><p>r</p></td>
<td><p>no</p></td>
<td><p>set in runtime</p></td>
</tr>
<tr class="row-even"><td><p>hasMemberOfFilterSupport</p></td>
<td><p>r</p></td>
<td><p>no</p></td>
<td><p>set in runtime</p></td>
</tr>
<tr class="row-odd"><td><p>useMemberOfToDetectMembership</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Whether to use memberOf to detect group memberships</p></td>
</tr>
<tr class="row-even"><td><p>ldapExpertUsernameAttr</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>LDAP attribute to use as internal username. Might be modified (e.g. to avoid name collisions, character restrictions)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapExpertUUIDUserAttr</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>override the LDAP servers UUID attribute to identify LDAP user records</p></td>
</tr>
<tr class="row-even"><td><p>ldapExpertUUIDGroupAttr</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>override the LDAP servers UUID attribute to identify LDAP group records</p></td>
</tr>
<tr class="row-odd"><td><p>lastJpegPhotoLookup</p></td>
<td><p>r</p></td>
<td><p>no</p></td>
<td><p>set in runtime</p></td>
</tr>
<tr class="row-even"><td><p>ldapNestedGroups</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Whether LDAP supports nested groups</p></td>
</tr>
<tr class="row-odd"><td><p>ldapPagingSize</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Number of results to return per page</p></td>
</tr>
<tr class="row-even"><td><p>turnOnPasswordChange</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Whether users are allowed to change passwords (hashing must happen on LDAP!)</p></td>
</tr>
<tr class="row-odd"><td><p>ldapDynamicGroupMemberURL</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>URL for dynamic groups</p></td>
</tr>
<tr class="row-even"><td><p>ldapDefaultPPolicyDN</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>PPolicy DN for password rules</p></td>
</tr>
<tr class="row-odd"><td><p>ldapConnectionTimeout</p></td>
<td><p>rw</p></td>
<td><p>no</p></td>
<td><p>Set the <code class="docutils literal notranslate"><span class="pre">LDAP_OPT_NETWORK_TIMEOUT</span></code> connection options. Default to 15 sec.</p></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"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_provisioning_api.html" class="btn btn-neutral float-right" title="User provisioning API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_auth_ldap_cleanup.html
+251
View File
@@ -0,0 +1,251 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>LDAP user cleanup &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="The LDAP configuration API" href="user_auth_ldap_api.html" />
<link rel="prev" title="User authentication with LDAP" href="user_auth_ldap.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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 current"><a class="current reference internal" href="#">LDAP user cleanup</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#deleting-local-nextcloud-users">Deleting local Nextcloud users</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">LDAP user cleanup</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_auth_ldap_cleanup.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="ldap-user-cleanup">
<h1>LDAP user cleanup<a class="headerlink" href="#ldap-user-cleanup" title="Link to this heading"></a></h1>
<p>LDAP User Cleanup is a new feature in the <code class="docutils literal notranslate"><span class="pre">LDAP</span> <span class="pre">user</span> <span class="pre">and</span> <span class="pre">group</span> <span class="pre">backend</span></code>
application. LDAP User Cleanup is a background process that automatically
searches the Nextcloud LDAP mappings table, and verifies if the LDAP users are
still available. Any users that are not available are marked as <code class="docutils literal notranslate"><span class="pre">deleted</span></code> in
the <code class="docutils literal notranslate"><span class="pre">oc_preferences</span></code> database table. Then you can run a command to display
this table, displaying only the users marked as <code class="docutils literal notranslate"><span class="pre">deleted</span></code>, and then you have
the option of removing their data from your Nextcloud data directory.</p>
<p>These items are removed upon cleanup:</p>
<ul class="simple">
<li><p>Local Nextcloud group assignments</p></li>
<li><p>User preferences (DB table <code class="docutils literal notranslate"><span class="pre">oc_preferences</span></code>)</p></li>
<li><p>User’s Nextcloud home folder</p></li>
<li><p>User’s corresponding entry in <code class="docutils literal notranslate"><span class="pre">oc_storages</span></code></p></li>
</ul>
<p>There are two prerequisites for LDAP User Cleanup to operate:</p>
<ol class="arabic simple">
<li><p>Set <code class="docutils literal notranslate"><span class="pre">ldapUserCleanupInterval</span></code> in <code class="docutils literal notranslate"><span class="pre">config.php</span></code> to your desired check
interval in minutes. The default is 51 minutes.</p></li>
<li><p>All configured LDAP connections are enabled and operating correctly. As users
can exist on multiple LDAP servers, you want to be sure that all of your
LDAP servers are available so that a user on a temporarily disconnected LDAP
server is not marked as <code class="docutils literal notranslate"><span class="pre">deleted</span></code>.</p></li>
</ol>
<p>The background process examines 50 users at a time, and runs at the interval you
configured with <code class="docutils literal notranslate"><span class="pre">ldapUserCleanupInterval</span></code>. For example, if you have 200 LDAP
users and your <code class="docutils literal notranslate"><span class="pre">ldapUserCleanupInterval</span></code> is 20 minutes, the process will
examine the first 50 users, then 20 minutes later the next 50 users, and 20
minutes later the next 50, and so on.</p>
<p>The amount of users to check can be set to a custom value via occ command. The
following example sets it to 300:</p>
<p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">www-data</span> <span class="pre">php</span> <span class="pre">occ</span> <span class="pre">config:app:set</span> <span class="pre">--value=300</span> <span class="pre">user_ldap</span> <span class="pre">cleanUpJobChunkSize</span></code></p>
<p>There are two <code class="docutils literal notranslate"><span class="pre">occ</span></code> commands to use for examining a table of users marked as
deleted, and then manually deleting them. The <code class="docutils literal notranslate"><span class="pre">occ</span></code> command is in your
Nextcloud directory, for example <code class="docutils literal notranslate"><span class="pre">/var/www/nextcloud/occ</span></code>, and it must be run as
your HTTP user. To learn more about <code class="docutils literal notranslate"><span class="pre">occ</span></code>, see
<a class="reference internal" href="../configuration_server/occ_command.html"><span class="doc">Using the occ command</span></a>.</p>
<p>These examples are for Ubuntu Linux:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">www-data</span> <span class="pre">php</span> <span class="pre">occ</span> <span class="pre">ldap:show-remnants</span></code> displays a table with all
users that have been marked as deleted, and their LDAP data.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">www-data</span> <span class="pre">php</span> <span class="pre">occ</span> <span class="pre">user:delete</span> <span class="pre">[user]</span></code> removes the user’s data from the
Nextcloud data directory.</p></li>
</ol>
<p>This example shows what the table of users marked as <code class="docutils literal notranslate"><span class="pre">deleted</span></code> looks like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ sudo -u www-data php occ ldap:show-remnants
+-----------------+-----------------+------------------+--------------------------------------+
| Nextcloud name | Display Name | LDAP UID | LDAP DN |
+-----------------+-----------------+------------------+--------------------------------------+
| aaliyah_brown | aaliyah brown | aaliyah_brown | uid=aaliyah_brown,ou=people,dc=com |
| aaliyah_hammes | aaliyah hammes | aaliyah_hammes | uid=aaliyah_hammes,ou=people,dc=com |
| aaliyah_johnston| aaliyah johnston| aaliyah_johnston | uid=aaliyah_johnston,ou=people,dc=com|
| aaliyah_kunze | aaliyah kunze | aaliyah_kunze | uid=aaliyah_kunze,ou=people,dc=com |
+-----------------+-----------------+------------------+--------------------------------------+
</pre></div>
</div>
<p>Following flags can be specified additionally:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">--short-date</span></code>: formats the dates for <code class="docutils literal notranslate"><span class="pre">Last</span> <span class="pre">login</span></code> and <code class="docutils literal notranslate"><span class="pre">Detected</span> <span class="pre">on</span></code> in a short Y-m-d format (e.g. 2019-01-14)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--json</span></code>: instead of a table, the output is json-encoded. This makes it easy to process the data programmatically.</p></li>
</ul>
<p>Then you can run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">www-data</span> <span class="pre">php</span> <span class="pre">occ</span> <span class="pre">user:delete</span> <span class="pre">aaliyah_brown</span></code> to delete
user aaliyah_brown. You must use the user’s Nextcloud name.</p>
<section id="deleting-local-nextcloud-users">
<h2>Deleting local Nextcloud users<a class="headerlink" href="#deleting-local-nextcloud-users" title="Link to this heading"></a></h2>
<p>You may also use <code class="docutils literal notranslate"><span class="pre">occ</span> <span class="pre">user:delete</span> <span class="pre">[user]</span></code> to remove a local Nextcloud user;
this removes their user account and their data.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_auth_ldap.html" class="btn btn-neutral float-left" title="User authentication with LDAP" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="user_auth_ldap_api.html" class="btn btn-neutral float-right" title="The LDAP configuration API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_configuration.html
+394
View File
@@ -0,0 +1,394 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User management &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Resetting a lost admin password" href="reset_admin_password.html" />
<link rel="prev" title="User management" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">User management</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">User management</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#creating-a-new-user">Creating a new user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#reset-a-user-s-password">Reset a user’s password</a></li>
<li class="toctree-l3"><a class="reference internal" href="#renaming-a-user">Renaming a user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#granting-administrator-privileges-to-a-user">Granting administrator privileges to a user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#managing-groups">Managing groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setting-storage-quotas">Setting Storage quotas</a></li>
<li class="toctree-l3"><a class="reference internal" href="#disable-and-enable-users">Disable and enable users</a></li>
<li class="toctree-l3"><a class="reference internal" href="#deleting-users">Deleting users</a></li>
</ul>
</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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">User management</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_configuration.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="user-management">
<h1>User management<a class="headerlink" href="#user-management" title="Link to this heading"></a></h1>
<p>On the User management page of your Nextcloud Web UI you can:</p>
<ul class="simple">
<li><p>Create new users</p></li>
<li><p>View all of your users in a single scrolling window</p></li>
<li><p>Filter users by group</p></li>
<li><p>See what groups they belong to</p></li>
<li><p>Edit their full names and passwords</p></li>
<li><p>See their data storage locations</p></li>
<li><p>View and set quotas</p></li>
<li><p>Create and edit their email addresses</p></li>
<li><p>Send an automatic email notification to new users</p></li>
<li><p>Disable and Enable users</p></li>
<li><p>Delete them with a single click</p></li>
</ul>
<p>The default view displays basic information about your users.</p>
<figure class="align-default">
<img alt="../_images/users-config.png" src="../_images/users-config.png" />
</figure>
<p>The Group filters on the left sidebar lets you quickly filter users by their
group memberships, and create new groups.</p>
<figure class="align-default">
<img alt="../_images/users-config-1.png" src="../_images/users-config-1.png" />
</figure>
<p>Click the gear icon on the lower left sidebar to set a default storage quota,
and to display additional fields: <strong>Show storage location, Show last log in,
Show user backend, Send email to new users,</strong> and <strong>Show email address</strong>.</p>
<figure class="align-default">
<img alt="../_images/users-config-2.png" src="../_images/users-config-2.png" />
</figure>
<p>User accounts have the following properties:</p>
<dl class="simple">
<dt><em>Login Name (Username)</em></dt><dd><p>The unique ID of a Nextcloud user, and it cannot be changed.</p>
</dd>
<dt><em>Full Name</em></dt><dd><p>The user’s display name that appears on file shares, the Nextcloud Web
interface, and emails. Admins and users may change the Full Name anytime. If
the Full Name is not set it defaults to the login name.</p>
</dd>
<dt><em>Password</em></dt><dd><p>The admin sets the new user’s first password. Both the user and the admin can
change the user’s password at anytime.</p>
</dd>
<dt><em>Groups</em></dt><dd><p>You may create groups, and assign group memberships to users. By default new
users are not assigned to any groups.</p>
</dd>
<dt><em>Group Admin</em></dt><dd><p>Group admins are granted administrative privileges on specific groups, and
can add and remove users from their groups.</p>
</dd>
<dt><em>Quota</em></dt><dd><p>The maximum disk space assigned to each user. Any user that exceeds the quota
cannot upload or sync data. You have the the option to include external
storage in user quotas.</p>
</dd>
<dt><em>Manager</em></dt><dd><p>Every user can have one organizational manager. The manager property goes into
the system address book card of the user and is used for the Contacts app’s
organization chart, for example. Setting a manager does <strong>not</strong> change any
authorization level of the user or their manager.</p>
</dd>
</dl>
<section id="creating-a-new-user">
<h2>Creating a new user<a class="headerlink" href="#creating-a-new-user" title="Link to this heading"></a></h2>
<p>To create a user account:</p>
<ul class="simple">
<li><p>Enter the new user’s <strong>Login Name</strong> and their initial <strong>Password</strong></p></li>
<li><p>Optionally, assign <strong>Groups</strong> memberships</p></li>
<li><p>Click the <strong>Create</strong> button</p></li>
</ul>
<figure class="align-default">
<img alt="../_images/users-create.png" src="../_images/users-create.png" />
</figure>
<p>Login names may contain letters (a-z, A-Z), numbers (0-9), dashes (-),
underscores (_), periods (.), spaces ( ) and at signs (&#64;). After creating the user, you
may fill in their <strong>Full Name</strong> if it is different than the login name, or
leave it for the user to complete.</p>
<p>If you have checked <strong>Send email to new user</strong> in the control panel on the
lower left sidebar, you may also enter the new user’s email address, and
Nextcloud will automatically send them a notification with their new login
information. You may edit this email using the email template editor on your
Admin page (see <a class="reference internal" href="../configuration_server/email_configuration.html"><span class="doc">Email</span></a>).</p>
<p>Set the <strong>Send email to new user</strong>-checkbox allows you to leave the <strong>Password</strong>
field empty. The user will get an activation-email to set their own password.</p>
</section>
<section id="reset-a-user-s-password">
<h2>Reset a user’s password<a class="headerlink" href="#reset-a-user-s-password" title="Link to this heading"></a></h2>
<p>You cannot recover a user’s password, but you can set a new one:</p>
<ul class="simple">
<li><p>Hover your cursor over the user’s <strong>Password</strong> field</p></li>
<li><p>Click on the <strong>pencil icon</strong></p></li>
<li><p>Enter the user’s new password in the password field, and remember to provide
the user with their password</p></li>
</ul>
<p>If you have encryption enabled, there are special considerations for user
password resets. Please see
<a class="reference internal" href="../configuration_files/encryption_configuration.html"><span class="doc">Encryption configuration</span></a>.</p>
</section>
<section id="renaming-a-user">
<h2>Renaming a user<a class="headerlink" href="#renaming-a-user" title="Link to this heading"></a></h2>
<p>Each Nextcloud user has two names: a unique <strong>Login Name</strong> used for
authentication, and a <strong>Full Name</strong>, which is their display name. You can edit
the display name of a user, but you cannot change the login name of any user.</p>
<p>To set or change a user’s display name:</p>
<ul class="simple">
<li><p>Hover your cursor over the user’s <strong>Full Name</strong> field</p></li>
<li><p>Click on the <strong>Pencil icon</strong></p></li>
<li><p>Enter the user’s new display name</p></li>
</ul>
</section>
<section id="granting-administrator-privileges-to-a-user">
<h2>Granting administrator privileges to a user<a class="headerlink" href="#granting-administrator-privileges-to-a-user" title="Link to this heading"></a></h2>
<p>Nextcloud has two types of administrators: <strong>Super Administrators</strong> and <strong>Group
Administrators</strong>. Group administrators have the rights to create, edit and
delete users in their assigned groups. Group administrators cannot access
system settings, or add or modify users in the groups that they are not <strong>Group
Administrators</strong> for. Use the dropdown menus in the <strong>Group Admin</strong> column to
assign group admin privileges.</p>
<figure class="align-default">
<img alt="../_images/users-groups.png" src="../_images/users-groups.png" />
</figure>
<p><strong>Super Administrators</strong> have full rights on your Nextcloud server, and can
access and modify all settings. To assign the <strong>Super Administrators</strong> role to
a user, simply add them to the <code class="docutils literal notranslate"><span class="pre">admin</span></code> group.</p>
</section>
<section id="managing-groups">
<h2>Managing groups<a class="headerlink" href="#managing-groups" title="Link to this heading"></a></h2>
<p>You can assign new users to groups when you create them, and create new groups
when you create new users. You may also use the <strong>Add Group</strong> button at the top
of the left pane to create new groups. New group members will immediately
have access to file shares that belong to their new groups.</p>
</section>
<section id="setting-storage-quotas">
<h2>Setting Storage quotas<a class="headerlink" href="#setting-storage-quotas" title="Link to this heading"></a></h2>
<p>Click the gear on the lower left pane to set a default storage quota. This is
automatically applied to new users. You may assign a different quota to any user
by selecting from the <strong>Quota</strong> dropdown, selecting either a preset value or
entering a custom value. When you create custom quotas, use the normal
abbreviations for your storage values such as 500 MB, 5 GB, 5 TB, and so on.</p>
<p>You now have a configurable option in <code class="docutils literal notranslate"><span class="pre">config.php</span></code> that controls whether
external storage is counted against user’s quotas. This is still
experimental, and may not work as expected. The default is to not count
external storage as part of user storage quotas. If you prefer to include it,
then change the default <code class="docutils literal notranslate"><span class="pre">false</span></code> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s1">&#39;quota_include_external_storage&#39;</span> <span class="o">=&gt;</span> <span class="n">false</span><span class="p">,</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If an external storage is defined as root, the quota will not
be calculable and will be <strong>ignored</strong>.</p>
</div>
<p>Metadata (such as thumbnails, temporary files, and encryption keys) takes up
about 10% of disk space, but is not counted against user quotas. Users can check
their used and available space on their Personal pages. Only files that
originate with users count against their quotas, and not files shared with them
that originate from other users. For example, if you upload files to a
different user’s share, those files count against your quota. If you re-share a
file that another user shared with you, that file does not count against your
quota, but the originating user’s.</p>
<p>Encrypted files are a little larger than unencrypted files; the unencrypted size
is calculated against the user’s quota.</p>
<p>Deleted files that are still in the trash bin do not count against quotas. The
trash bin is set at 50% of quota. Deleted file aging is set at 30 days. When
deleted files exceed 50% of quota then the oldest files are removed until the
total is below 50%.</p>
<p>When version control is enabled, the older file versions are not counted
against quotas.</p>
<p>When a user creates a public share via URL, and allows uploads, any uploaded
files count against that user’s quota.</p>
</section>
<section id="disable-and-enable-users">
<h2>Disable and enable users<a class="headerlink" href="#disable-and-enable-users" title="Link to this heading"></a></h2>
<figure class="align-default">
<img alt="../_images/users-actions.png" src="../_images/users-actions.png" />
</figure>
<p>Sometimes you may want to disable a user without permanently deleting their
settings and files. The user can be activated any time again, without data-loss.</p>
<p>Hover your cursor over their name on the <strong>Users</strong> page until the “…”-menu icon
appears at the far right. After clicking on it, you will see the <strong>Disable</strong> option.</p>
<p>The user will not longer be able to access their Nextcloud until you enable them again.
Also all external shares, via public link or email, will not be accessible.
Internal shares will still be working, so that other users on Nextcloud can continue working.</p>
<p>If you wish for internal shares to be disabled as well when a user is disabled,
activate the configuration option files_sharing:hide_disabled_user_shares:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">occ</span> <span class="n">config</span><span class="p">:</span><span class="n">app</span><span class="p">:</span><span class="nb">set</span> <span class="n">files_sharing</span> <span class="n">hide_disabled_user_shares</span> <span class="o">--</span><span class="n">value</span> <span class="n">yes</span>
</pre></div>
</div>
<p>You will find all disabled users in the <strong>disabled</strong>-section on the left pane.
Enabling users is as easy as disabling them. Just click on the “…”-menu, and
select <strong>Enable</strong>.</p>
</section>
<section id="deleting-users">
<h2>Deleting users<a class="headerlink" href="#deleting-users" title="Link to this heading"></a></h2>
<figure class="align-default">
<img alt="../_images/users-actions.png" src="../_images/users-actions.png" />
</figure>
<p>Deleting a user is easy: hover your cursor over their name on the <strong>Users</strong> page
until the “…”-menu icon appears at the far right. After clicking on it, you will
see the <strong>Delete</strong> option. Clicking on it, deletes a user with all their data immediately.</p>
<p>You’ll see an undo button at the top of the page, which remains for some seconds.
When the undo button is gone you cannot recover the deleted user.</p>
<p>All of the files owned by the user are deleted as well, including all files they
have shared. If you need to preserve the user’s files and shares, you must first
download them from your Nextcloud Files page, which compresses them into a zip
file, or use a sync client to copy them to your local computer. See
<a class="reference internal" href="../configuration_files/file_sharing_configuration.html"><span class="doc">File Sharing</span></a> to learn how to create
persistent file shares that survive user deletions.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="User management" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="reset_admin_password.html" class="btn btn-neutral float-right" title="Resetting a lost admin password" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_password_policy.html
+197
View File
@@ -0,0 +1,197 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User password policy &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Two-factor authentication" href="two_factor-auth.html" />
<link rel="prev" title="Resetting a user password" href="reset_user_password.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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 current"><a class="current reference internal" href="#">User password policy</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_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></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>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">User password policy</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_password_policy.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="user-password-policy">
<h1>User password policy<a class="headerlink" href="#user-password-policy" title="Link to this heading"></a></h1>
<p>A password policy is a set of rules designed to enhance computer security by encouraging users to employ strong passwords and use them properly.</p>
<p>In the security-section of your administrator-settings you can configure</p>
<ul class="simple">
<li><p>a minimal length of a password. Default is 10 characters.</p></li>
<li><p>a password history</p></li>
<li><p>a password expiration period</p></li>
<li><p>a lockout policy</p></li>
<li><p>to forbid common passwords like ‘password’ or ‘login’.</p></li>
<li><p>to enforce upper and lower case characters</p></li>
<li><p>to enforce numeric characters</p></li>
<li><p>to enforce special characters like ! or :</p></li>
<li><p>to check the password against the list of breached passwords from haveibeenpwnd.com (hashed check via haveibeenpwnd.com-API)</p></li>
</ul>
<figure class="align-default">
<img alt="../_images/user_password_policy_configuration_app.png" src="../_images/user_password_policy_configuration_app.png" />
</figure>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="reset_user_password.html" class="btn btn-neutral float-left" title="Resetting a user password" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="two_factor-auth.html" class="btn btn-neutral float-right" title="Two-factor authentication" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
wedding-pics/core/doc/admin/configuration_user/user_provisioning_api.html
+204
View File
@@ -0,0 +1,204 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>User provisioning API &mdash; Nextcloud latest Administration Manual latest documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/general.css" type="text/css" />
<link rel="stylesheet" href="../_static/dark_mode_css/dark.css" type="text/css" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/dark_mode_js/default_light.js?v=c2e647ce"></script>
<script src="../_static/dark_mode_js/theme_switcher.js?v=358d3910"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Instruction set for users" href="instruction_set_for_users.html" />
<link rel="prev" title="The LDAP configuration API" href="user_auth_ldap_api.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../contents.html">
<img src="../_static/logo-white.png" class="logo" alt="Logo"/>
</a>
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes/index.html">Release notes</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="../installation/index.html">Installation and server configuration</a></li>
<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="../apps_management.html">Apps management</a></li>
<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="two_factor-auth.html">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_auth_ftp_smb_imap.html">User authentication with IMAP, SMB, FTP and others</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"><a class="reference internal" href="user_auth_ldap_api.html">The LDAP configuration API</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">User provisioning API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_users.html">Instruction set for users</a></li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_groups.html">Instruction set for groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="instruction_set_for_apps.html">Instruction set for apps</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="profile_configuration.html">Profile configuration</a></li>
</ul>
</li>
<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="../groupware/index.html">Groupware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../office/index.html">Office</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="../ai/index.html">Artificial Intelligence</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
<li class="toctree-l1"><a class="reference internal" href="../gdpr/index.html">GDPR-compliance</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" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<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">User provisioning API</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/configuration_user/user_provisioning_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="user-provisioning-api">
<h1>User provisioning API<a class="headerlink" href="#user-provisioning-api" title="Link to this heading"></a></h1>
<p>The Provisioning API application enables a set of APIs that external systems can use to create,
edit, delete and query user attributes, query, set and remove groups, set quota
and query total storage used in Nextcloud. Group admin users can also query
Nextcloud and perform the same functions as an admin for groups they manage. The
API also enables an admin to query for active Nextcloud applications, application
info, and to enable or disable an app remotely. HTTP
requests can be used via a Basic Auth header to perform any of the functions
listed above. The Provisioning API app is enabled by default.</p>
<p>The base URL for all calls to the share API is <code class="docutils literal notranslate"><span class="pre">https://cloud.example.com/ocs/v1.php/cloud</span></code>.</p>
<p>All calls to OCS endpoints require the <code class="docutils literal notranslate"><span class="pre">OCS-APIRequest</span></code> header to be set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>All POST requests require the <code class="docutils literal notranslate"><span class="pre">Content-Type:</span> <span class="pre">application/x-www-form-urlencoded</span></code> header. (Note: Some libraries like cURL set this header automatically, others require setting the header explicitly.)</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="instruction_set_for_users.html">Instruction set for users</a></li>
<li class="toctree-l1"><a class="reference internal" href="instruction_set_for_groups.html">Instruction set for groups</a></li>
<li class="toctree-l1"><a class="reference internal" href="instruction_set_for_apps.html">Instruction set for apps</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="user_auth_ldap_api.html" class="btn btn-neutral float-left" title="The LDAP configuration API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="instruction_set_for_users.html" class="btn btn-neutral float-right" title="Instruction set for users" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024 Nextcloud GmbH.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Versions</dt>
<dd><a href="https://docs.nextcloud.com/server/25/admin_manual">25</a></dd>
<dd><a href="https://docs.nextcloud.com/server/26/admin_manual">26</a></dd>
<dd><a href="https://docs.nextcloud.com/server/27/admin_manual">27</a></dd>
<dd><a href="https://docs.nextcloud.com/server/stable/admin_manual">stable</a></dd>
<dd><a href="https://docs.nextcloud.com/server/latest/admin_manual">latest</a></dd>
</dl>
<dl>
<dt>Downloads</dt>
</dl>
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="///projects//?fromdocs=">Project Home</a>
</dd>
<dd>
<a href="///builds//?fromdocs=">Builds</a>
</dd>
</dl>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>