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

cut new release

Browse Source
This commit is contained in:
ngrok-release-bot
2021-05-21 15:02:28 +00:00
parent 436d30f0cd
commit 9c8e482eaa
65 changed files with 3875 additions and 2521 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ssh_credentials.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -181,8 +181,11 @@
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the PEM-encoded public key of the SSH keypair that will be used to authenticate</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-create">https://ngrok.com/docs/api#api-ssh-credentials-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -195,6 +198,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-delete">https://ngrok.com/docs/api#api-ssh-credentials-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.SSHCredentialsClient.get">
@@ -204,8 +208,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-get">https://ngrok.com/docs/api#api-ssh-credentials-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -220,8 +227,11 @@
<li><p><strong>limit</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>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredentialList" title="ngrok.objects.SSHCredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-list">https://ngrok.com/docs/api#api-ssh-credentials-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredentialList" title="ngrok.datatypes.SSHCredentialList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredentialList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -238,8 +248,11 @@
<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>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.SSHCredential" title="ngrok.objects.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-credentials-update">https://ngrok.com/docs/api#api-ssh-credentials-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.SSHCredential" title="ngrok.datatypes.SSHCredential"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCredential</span></code></a></p>
</dd>
</dl>
</dd></dl>