ngrok/ngrok-api-python
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-python.git synced 2026-06-16 16:54:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update generated files

Browse Source
This commit is contained in:
ngrok release bot
2023-03-13 23:06:28 +00:00
parent 73479addb9
commit cdf67b49df
82 changed files with 4069 additions and 839 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/credentials.html
+6 -3
View File
@@ -118,6 +118,8 @@
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
@@ -190,14 +192,15 @@ the <code class="docutils literal notranslate"><span class="pre">ngrok</span> <s
configuration file with the <code class="docutils literal notranslate"><span class="pre">authtoken</span></code> property.</p>
<dl class="py method">
<dt id="ngrok.services.CredentialsClient.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.create" title="Permalink to this definition"></a></dt>
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.create" title="Permalink to this definition"></a></dt>
<dd><p>Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
</ul>
</dd>
</dl>
@@ -264,7 +267,7 @@ configuration file with the <code class="docutils literal notranslate"><span cla
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
</ul>
</dd>
</dl>