Publish new build of docs

Author: github-actions[bot]

dev/genindex.html

@@ -2031,17 +2031,19 @@ <h2 id="I">I</h2>
 </li>
       </ul></li>
       <li><a href="modules/schema.html#octoprint.schema.config.controls.ControlConfig.input">input (octoprint.schema.config.controls.ControlConfig attribute)</a>
+</li>
+      <li><a href="modules/access.html#octoprint.access.users.InternalUser">InternalUser (class in octoprint.access.users)</a>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.server.OnlineCheckConfig.interval">interval (octoprint.schema.config.server.OnlineCheckConfig attribute)</a>
 
       <ul>
         <li><a href="modules/schema.html#octoprint.schema.config.webcam.TimelapseOptions.interval">(octoprint.schema.config.webcam.TimelapseOptions attribute)</a>
 </li>
       </ul></li>
-      <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.invalid_syntax">invalid_syntax (octoprint.plugin.core.PluginInfo attribute)</a>
-</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.invalid_syntax">invalid_syntax (octoprint.plugin.core.PluginInfo attribute)</a>
+</li>
       <li><a href="modules/printer.html#octoprint.printer.profile.InvalidProfileError">InvalidProfileError (class in octoprint.printer.profile)</a>
 </li>
       <li><a href="modules/access.html#octoprint.access.users.InvalidUsername">InvalidUsername</a>
@@ -3404,6 +3406,8 @@ <h2 id="P">P</h2>
       <li><a href="modules/schema.html#octoprint.schema.config.access_control.AccessControlConfig.permissionManager">permissionManager (octoprint.schema.config.access_control.AccessControlConfig attribute)</a>
 </li>
       <li><a href="modules/plugin.html#octoprint.plugin.core.Plugin">Plugin (class in octoprint.plugin.core)</a>
+</li>
+      <li><a href="modules/plugin.html#octoprint.plugin.types.OctoPrintPlugin.plugin_apikey">plugin_apikey (octoprint.plugin.types.OctoPrintPlugin property)</a>
 </li>
       <li><a href="modules/plugin.html#octoprint.plugin.core.PluginManager.plugin_hooks">plugin_hooks (octoprint.plugin.core.PluginManager property)</a>
 </li>
@@ -3462,11 +3466,11 @@ <h2 id="P">P</h2>
       <li><a href="modules/util.html#octoprint.util.pp">pp() (in module octoprint.util)</a>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.devel.DevelCacheConfig.preemptive">preemptive (octoprint.schema.config.devel.DevelCacheConfig attribute)</a>
-</li>
-      <li><a href="modules/schema.html#octoprint.schema.config.server.ServerConfig.preemptiveCache">preemptiveCache (octoprint.schema.config.server.ServerConfig attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="modules/schema.html#octoprint.schema.config.server.ServerConfig.preemptiveCache">preemptiveCache (octoprint.schema.config.server.ServerConfig attribute)</a>
+</li>
       <li><a href="modules/schema.html#octoprint.schema.config.server.PreemptiveCacheConfig">PreemptiveCacheConfig (class in octoprint.schema.config.server)</a>
 </li>
       <li><a href="modules/server.html#octoprint.server.util.flask.PrefixAwareJinjaEnvironment">PrefixAwareJinjaEnvironment (class in octoprint.server.util.flask)</a>

dev/modules/access.html

@@ -592,6 +592,18 @@
     </span>
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#octoprint.access.users.InternalUser" class="md-nav__link">
+    
+      <span aria-label="Python class" class="objinfo-icon objinfo-icon__data" title="Python class">C</span>
+    
+    <span class="md-ellipsis">
+      <span title="octoprint.access.users.InternalUser (Python class)"><span>octoprint.<wbr>access.<wbr>users.<wbr>Internal<wbr>User</span></span>
+    </span>
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -1431,6 +1443,18 @@
     </span>
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#octoprint.access.users.InternalUser" class="md-nav__link">
+    
+      <span aria-label="Python class" class="objinfo-icon objinfo-icon__data" title="Python class">C</span>
+    
+    <span class="md-ellipsis">
+      <span title="octoprint.access.users.InternalUser (Python class)"><span>octoprint.<wbr>access.<wbr>users.<wbr>Internal<wbr>User</span></span>
+    </span>
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -1535,6 +1559,11 @@ <h1 id="module-octoprint.access.users"><span id="octoprint-access-users"></span>
 <em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">octoprint.access.users.</span></span><span class="sig-name descname"><span class="pre">CorruptUserStorage</span></span><a class="headerlink" href="#octoprint.access.users.CorruptUserStorage" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py class objdesc">
+<dt class="sig sig-object highlight py" id="octoprint.access.users.InternalUser">
+<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">octoprint.access.users.</span></span><span class="sig-name descname"><span class="pre">InternalUser</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.access.users.InternalUser" title="octoprint.access.users.InternalUser.__init__.groups (Python parameter)"><span class="n"><span class="pre">groups</span></span></a></em></span><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.access.users.InternalUser" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py exception objdesc">
 <dt class="sig sig-object highlight py" id="octoprint.access.users.InvalidUsername">
 <em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">octoprint.access.users.</span></span><span class="sig-name descname"><span class="pre">InvalidUsername</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.access.users.InvalidUsername" title="octoprint.access.users.InvalidUsername.__init__.username (Python parameter)"><span class="n"><span class="pre">username</span></span></a></em></span><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.access.users.InvalidUsername" title="Link to this definition">¶</a></dt>

dev/modules/index.html

@@ -1608,6 +1608,7 @@ <h1 id="internal-modules"><span id="sec-modules"></span>Internal Modules<a class
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.AnonymousUser">octoprint.access.users.AnonymousUser</a></li>
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.ApiUser">octoprint.access.users.ApiUser</a></li>
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.CorruptUserStorage">octoprint.access.users.CorruptUserStorage</a></li>
+<li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.InternalUser">octoprint.access.users.InternalUser</a></li>
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.InvalidUsername">octoprint.access.users.InvalidUsername</a></li>
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.UnknownRole">octoprint.access.users.UnknownRole</a></li>
 <li class="toctree-l2"><a class="reference internal" href="access.html#octoprint.access.users.UnknownUser">octoprint.access.users.UnknownUser</a></li>
@@ -1945,6 +1946,7 @@ <h1 id="internal-modules"><span id="sec-modules"></span>Internal Modules<a class
 <li class="toctree-l3"><a class="reference internal" href="plugin.html#octoprint.plugin.types.OctoPrintPlugin._data_folder">_data_folder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="plugin.html#octoprint.plugin.types.OctoPrintPlugin.get_plugin_data_folder">get_plugin_data_folder</a></li>
 <li class="toctree-l3"><a class="reference internal" href="plugin.html#octoprint.plugin.types.OctoPrintPlugin.on_plugin_pending_uninstall">on_plugin_pending_uninstall</a></li>
+<li class="toctree-l3"><a class="reference internal" href="plugin.html#octoprint.plugin.types.OctoPrintPlugin.plugin_apikey">plugin_apikey</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="plugin.html#octoprint.plugin.types.ReloadNeedingPlugin">octoprint.plugin.types.ReloadNeedingPlugin</a></li>

dev/modules/plugin.html

@@ -10506,6 +10506,32 @@
 
 
 
+              
+                
+  
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="#octoprint.plugin.types.OctoPrintPlugin.plugin_apikey" class="md-nav__link">
+        
+  
+  
+    <span aria-label="Python property" class="objinfo-icon objinfo-icon__alias" title="Python property">P</span>
+  
+  <span class="md-ellipsis">
+    <span title="octoprint.plugin.types.OctoPrintPlugin.plugin_apikey (Python property) — Returns a single-use API key that may be used by the plugin to perform authenticated requests against the server&#39;s HTTP endpoints, e.g. to call the endpoints of other third party plugins without registered helpers."><span>plugin_<wbr>apikey</span></span>
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
 
@@ -14806,6 +14832,15 @@ <h1 id="module-octoprint.plugin.types"><span id="octoprint-plugin-types"></span>
 <p>NOT called during plugin uninstalls triggered outside of OctoPrint!</p>
 </dd></dl>
 
+<dl class="py property objdesc">
+<dt class="sig sig-object highlight py" id="octoprint.plugin.types.OctoPrintPlugin.plugin_apikey">
+<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">plugin_apikey</span></span><a class="headerlink" href="#octoprint.plugin.types.OctoPrintPlugin.plugin_apikey" title="Link to this definition">¶</a></dt>
+<dd><p>Returns a single-use API key that may be used by the plugin
+to perform authenticated requests against the server’s HTTP endpoints,
+e.g. to call the endpoints of other third party plugins without
+registered helpers.</p>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="py class objdesc">

dev/modules/server.html

@@ -1485,6 +1485,32 @@
 
 
 
+              
+                
+  
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="#octoprint.server.util.get_user_for_apikey.remote_address" class="md-nav__link">
+        
+  
+  
+    <span aria-label="Python parameter" class="objinfo-icon objinfo-icon__sub-data" title="Python parameter">p</span>
+  
+  <span class="md-ellipsis">
+    <span title="octoprint.server.util.get_user_for_apikey.remote_address (Python parameter) — the (optional) remote address of the client"><span>remote_<wbr>address</span></span>
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
 
@@ -9900,7 +9926,7 @@ <h1 id="module-octoprint.server.util"><span id="octoprint-server-util"></span><s
 
 <dl class="py function objdesc">
 <dt class="sig sig-object highlight sig-wrap py" id="octoprint.server.util.get_user_for_apikey">
-<span class="sig-prename descclassname"><span class="pre">octoprint.server.util.</span></span><span class="sig-name descname"><span class="pre">get_user_for_apikey</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.server.util.get_user_for_apikey.apikey" title="octoprint.server.util.get_user_for_apikey.apikey (Python parameter) — the API key to check"><span class="n"><span class="pre">apikey</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><a class="reference internal" href="access.html#octoprint.access.users.User" title="octoprint.access.users.User (Python class) — Deprecated since version 1.4.0: Replaced by as_dict()"><span class="pre">User</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span></span><a class="headerlink" href="#octoprint.server.util.get_user_for_apikey" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">octoprint.server.util.</span></span><span class="sig-name descname"><span class="pre">get_user_for_apikey</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.server.util.get_user_for_apikey.apikey" title="octoprint.server.util.get_user_for_apikey.apikey (Python parameter) — the API key to check"><span class="n"><span class="pre">apikey</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.server.util.get_user_for_apikey.remote_address" title="octoprint.server.util.get_user_for_apikey.remote_address (Python parameter) — the (optional) remote address of the client"><span class="n"><span class="pre">remote_address</span></span></a><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="desctype"><a class="reference internal" href="access.html#octoprint.access.users.User" title="octoprint.access.users.User (Python class) — Deprecated since version 1.4.0: Replaced by as_dict()"><span class="pre">User</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span></span><a class="headerlink" href="#octoprint.server.util.get_user_for_apikey" title="Link to this definition">¶</a></dt>
 <dd><p>Tries to find a user based on the given API key.</p>
 <p>Will only perform any action if the API key is not None and not empty.</p>
 <p>If the API key is the master key, the master user will be returned.</p>
@@ -9912,6 +9938,8 @@ <h1 id="module-octoprint.server.util"><span id="octoprint-server-util"></span><s
 <dd class="field-odd"><dl class="simple api-field highlight">
 <dt id="octoprint.server.util.get_user_for_apikey.apikey"><span class="sig-name descname">apikey</span><span class="p"> : </span><span class="desctype"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a></span></span><a class="headerlink" href="#octoprint.server.util.get_user_for_apikey.apikey" title="Permalink to this definition">¶</a></dt><dd><p>the API key to check</p>
 </dd>
+<dt id="octoprint.server.util.get_user_for_apikey.remote_address"><span class="sig-name descname">remote_address</span><span class="p"> : </span><span class="desctype"><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a></span></span><a class="headerlink" href="#octoprint.server.util.get_user_for_apikey.remote_address" title="Permalink to this definition">¶</a></dt><dd><p>the (optional) remote address of the client</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even" id="octoprint.server.util.get_user_for_apikey-returns">Returns<span class="colon">:</span><a class="headerlink" href="#octoprint.server.util.get_user_for_apikey-returns" title="Permalink to this headline">¶</a></dt>