mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
ngrok release bot
342 lines
28 KiB
HTML
342 lines
28 KiB
HTML
<!doctype html>
|
||
<html class="no-js">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TLS Certificates" href="tls_certificates.html" /><link rel="prev" title="SSH Host Certificates" href="ssh_host_certificates.html" />
|
||
|
||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||
<title>SSH User Certificates - ngrok-api documentation</title>
|
||
<link rel="stylesheet" href="_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
||
<link rel="stylesheet" href="_static/pygments.css">
|
||
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
||
|
||
|
||
|
||
<style>
|
||
:root {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
:root {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
|
||
/* For allowing end-user-specific overrides */
|
||
.override-light {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
.override-dark {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
</style><link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
||
<body dir="">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||
<line x1="4" y1="6" x2="20" y2="6" />
|
||
<line x1="10" y1="12" x2="20" y2="12" />
|
||
<line x1="6" y1="18" x2="20" y2="18" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||
class="feather feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||
class="feather feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||
<label class="overlay toc-overlay" for="__toc"></label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
|
||
|
||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html">
|
||
<input class="sidebar-search" placeholder=Search name="q">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<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="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>
|
||
<ul class="current">
|
||
<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>
|
||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">SSH User Certificates</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tls_certificates.html">TLS Certificates</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnel_sessions.html">Tunnel Sessions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tunnels.html">Tunnels</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<main class="main">
|
||
<div class="content">
|
||
<article role="main">
|
||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
<div class="section" id="ssh-user-certificates">
|
||
<h1>SSH User Certificates<a class="headerlink" href="#ssh-user-certificates" title="Permalink to this headline">¶</a></h1>
|
||
<p>Do not construct this object directly, instead access the
|
||
<a class="reference internal" href="client.html#ngrok.Client.ssh_user_certificates" title="ngrok.Client.ssh_user_certificates"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ssh_user_certificates</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">SSHUserCertificatesClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>SSH User Certificates are presented by SSH clients when connecting to an SSH
|
||
server to authenticate their connection. The SSH server must trust the SSH
|
||
Certificate Authority used to sign the certificate.</p>
|
||
<dl class="py method">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient.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">ssh_certificate_authority_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">public_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">principals</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">critical_options</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">extensions</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">valid_after</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">valid_until</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">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><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.create" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a new SSH User Certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ssh_certificate_authority_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the ssh certificate authority that is used to sign this ssh user certificate</p></li>
|
||
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a public key in OpenSSH Authorized Keys format that this certificate signs</p></li>
|
||
<li><p><strong>principals</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>]) – the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</p></li>
|
||
<li><p><strong>critical_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code class="docutils literal notranslate"><span class="pre">force-command</span></code> and <code class="docutils literal notranslate"><span class="pre">source-address</span></code>. See <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p></li>
|
||
<li><p><strong>extensions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – <p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code class="docutils literal notranslate"><span class="pre">{"permit-pty":</span> <span class="pre">"",</span> <span class="pre">"permit-user-rc":</span> <span class="pre">""}</span></code> OpenSSH understands a number of predefined extensions. See <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
|
||
</p></li>
|
||
<li><p><strong>valid_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</p></li>
|
||
<li><p><strong>valid_until</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code class="docutils literal notranslate"><span class="pre">valid_before</span></code>.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this SSH User Certificate. 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 SSH User Certificate. optional, max 4096 bytes.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-create">https://ngrok.com/docs/api#api-ssh-user-certificates-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.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete an SSH User Certificate</p>
|
||
<dl class="field-list simple">
|
||
<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>
|
||
</dl>
|
||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-delete">https://ngrok.com/docs/api#api-ssh-user-certificates-delete</a></p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient.get">
|
||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get detailed information about an SSH User Certficate</p>
|
||
<dl class="field-list simple">
|
||
<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>
|
||
</dl>
|
||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-get">https://ngrok.com/docs/api#api-ssh-user-certificates-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.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient.list">
|
||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</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#SSHUserCertificatesClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List all SSH User Certificates issued on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>before_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>]) – </p></li>
|
||
<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>
|
||
</dl>
|
||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">https://ngrok.com/docs/api#api-ssh-user-certificates-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.SSHUserCertificateList" title="ngrok.datatypes.SSHUserCertificateList"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificateList</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.services.SSHUserCertificatesClient.update">
|
||
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <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">None</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHUserCertificatesClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHUserCertificatesClient.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update an SSH User Certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<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 this SSH User Certificate. 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 SSH User Certificate. optional, max 4096 bytes.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-ssh-user-certificates-update">https://ngrok.com/docs/api#api-ssh-user-certificates-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.SSHUserCertificate" title="ngrok.datatypes.SSHUserCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHUserCertificate</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
</div>
|
||
|
||
</article>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="tls_certificates.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">TLS Certificates</div>
|
||
</div>
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="ssh_host_certificates.html">
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">SSH Host Certificates</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="related-information">
|
||
Copyright © 1980, ngrok Inc.
|
||
|
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
|
||
and
|
||
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
||
|
|
||
<a class="muted-link" href="_sources/ssh_user_certificates.rst.txt"
|
||
rel="nofollow">
|
||
Show Source
|
||
</a>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer no-toc">
|
||
|
||
|
||
|
||
</aside>
|
||
</main>
|
||
</div>
|
||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/scripts/main.js?digest=e931d09b2a40c1bb82b542effe772014573baf67"></script></body>
|
||
</html> |