mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
Alan Shreve
4584 lines
376 KiB
HTML
4584 lines
376 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="Errors" href="errors.html" /><link rel="prev" title="Client" href="client.html" />
|
||
|
||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||
<title>Datatypes - 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 class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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>
|
||
<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="api_keys.html">API Keys</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="endpoint_configurations.html">Endpoint Configurations</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="event_streams.html">Event Streams</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="ip_whitelist.html">IP Whitelist</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_logging_module.html">Logging Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_circuit_breaker_module.html">Circuit Breaker Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_compression_module.html">Compression Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_tls_termination_module.html">TLS Termination Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_ip_policy_module.html">IP Policy Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_mutual_tls_module.html">Mutual TLS Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_request_headers_module.html">Request Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_response_headers_module.html">Response Headers Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_o_auth_module.html">OAuth Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_webhook_validation_module.html">Webhook Validation Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_saml_module.html">SAML Module</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="endpoint_oidc_module.html">OIDC Module</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"><a class="reference internal" href="ssh_user_certificates.html">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="datatypes">
|
||
<h1>Datatypes<a class="headerlink" href="#datatypes" title="Permalink to this headline">¶</a></h1>
|
||
<p>This module contains all datatypes returned by the ngrok API.</p>
|
||
<span class="target" id="module-ngrok.datatypes"></span><dl class="py class">
|
||
<dt id="ngrok.datatypes.APIKey">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">APIKey</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#APIKey"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.APIKey" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the api key was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#APIKey.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.APIKey.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique API key resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.token">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.token" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. <strong>This value is only available one time, on the API response from key creation. Otherwise it is null.</strong></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.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">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/datatypes.html#APIKey.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.APIKey.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKey.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI to the API resource of this API key</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.APIKeyList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">APIKeyList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#APIKeyList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.APIKeyList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKeyList.keys">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">keys</span></code><a class="headerlink" href="#ngrok.datatypes.APIKeyList.keys" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of API keys for this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.APIKey" title="ngrok.datatypes.APIKey"><code class="xref py py-class docutils literal notranslate"><span class="pre">APIKey</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKeyList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.APIKeyList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.APIKeyList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.APIKeyList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the API keys list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.AWSAuth">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">AWSAuth</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#AWSAuth"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.AWSAuth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.AWSAuth.creds">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">creds</span></code><a class="headerlink" href="#ngrok.datatypes.AWSAuth.creds" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.AWSCredentials" title="ngrok.datatypes.AWSCredentials"><code class="xref py py-class docutils literal notranslate"><span class="pre">AWSCredentials</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AWSAuth.role">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">role</span></code><a class="headerlink" href="#ngrok.datatypes.AWSAuth.role" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A role for ngrok to assume on your behalf to deposit events into your AWS account.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.AWSRole" title="ngrok.datatypes.AWSRole"><code class="xref py py-class docutils literal notranslate"><span class="pre">AWSRole</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.AWSCredentials">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">AWSCredentials</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#AWSCredentials"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.AWSCredentials" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.AWSCredentials.aws_access_key_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aws_access_key_id</span></code><a class="headerlink" href="#ngrok.datatypes.AWSCredentials.aws_access_key_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The ID portion of an AWS access key.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AWSCredentials.aws_secret_access_key">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">aws_secret_access_key</span></code><a class="headerlink" href="#ngrok.datatypes.AWSCredentials.aws_secret_access_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The secret portion of an AWS access key.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.AWSRole">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">AWSRole</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#AWSRole"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.AWSRole" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.AWSRole.role_arn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">role_arn</span></code><a class="headerlink" href="#ngrok.datatypes.AWSRole.role_arn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An ARN that specifies the role that ngrok should use to deliver to the configured target.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.AbuseReport">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">AbuseReport</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#AbuseReport"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.AbuseReport" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp that the abuse report record was created in RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.hostnames">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">hostnames</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.hostnames" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>an array of hostname statuses related to the report</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.AbuseReportHostname" title="ngrok.datatypes.AbuseReportHostname"><code class="xref py py-class docutils literal notranslate"><span class="pre">AbuseReportHostname</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ID of the abuse report</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.status">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">status</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates whether ngrok has processed the abuse report. one of <code class="docutils literal notranslate"><span class="pre">PENDING</span></code>, <code class="docutils literal notranslate"><span class="pre">PROCESSED</span></code>, or <code class="docutils literal notranslate"><span class="pre">PARTIALLY_PROCESSED</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the abuse report API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReport.urls">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">urls</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReport.urls" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of URLs containing suspected abusive content</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.AbuseReportHostname">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">AbuseReportHostname</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#AbuseReportHostname"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.AbuseReportHostname" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReportHostname.hostname">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">hostname</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReportHostname.hostname" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the hostname ngrok has parsed out of one of the reported URLs in this abuse report</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.AbuseReportHostname.status">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">status</span></code><a class="headerlink" href="#ngrok.datatypes.AbuseReportHostname.status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>indicates what action ngrok has taken against the hostname. one of <code class="docutils literal notranslate"><span class="pre">PENDING</span></code>, <code class="docutils literal notranslate"><span class="pre">BANNED</span></code>, <code class="docutils literal notranslate"><span class="pre">UNBANNED</span></code>, or <code class="docutils literal notranslate"><span class="pre">IGNORE</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.CertificateAuthority">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">CertificateAuthority</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#CertificateAuthority"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.ca_pem">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ca_pem</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.ca_pem" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>raw PEM of the Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the Certificate Authority was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#CertificateAuthority.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this Certificate Authority. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.extended_key_usages">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">extended_key_usages</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.extended_key_usages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>extended set of actions the private key of this Certificate Authority can be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.key_usages">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">key_usages</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.key_usages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>set of actions the private key of this Certificate Authority can be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.not_after">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">not_after</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.not_after" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when this Certificate Authority becomes invalid, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.not_before">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">not_before</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.not_before" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when this Certificate Authority becomes valid, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.subject_common_name">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_common_name</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.subject_common_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject common name of the Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.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">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/datatypes.html#CertificateAuthority.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthority.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthority.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Certificate Authority API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.CertificateAuthorityList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">CertificateAuthorityList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#CertificateAuthorityList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.CertificateAuthorityList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthorityList.certificate_authorities">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_authorities</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthorityList.certificate_authorities" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all certificate authorities on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.CertificateAuthority" title="ngrok.datatypes.CertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertificateAuthority</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthorityList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthorityList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CertificateAuthorityList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.CertificateAuthorityList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the certificates authorities list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.Credential">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">Credential</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Credential"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Credential" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.acl">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">acl</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.acl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the tunnel credential was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Credential.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Credential.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique tunnel credential resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.token">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">token</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.token" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the credential’s authtoken that can be used to authenticate an ngrok client. <strong>This value is only available one time, on the API response from credential creation, otherwise it is null.</strong></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.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">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>, <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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Credential.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Credential.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Credential.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the tunnel credential API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.CredentialList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">CredentialList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#CredentialList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.CredentialList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.CredentialList.credentials">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credentials</span></code><a class="headerlink" href="#ngrok.datatypes.CredentialList.credentials" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all tunnel credentials on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Credential" title="ngrok.datatypes.Credential"><code class="xref py py-class docutils literal notranslate"><span class="pre">Credential</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CredentialList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.CredentialList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.CredentialList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.CredentialList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the tunnel credential list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointCircuitBreaker</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointCircuitBreaker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.error_threshold_percentage">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">error_threshold_percentage</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.error_threshold_percentage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Error threshold percentage should be between 0 - 1.0, not 0-100.0</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.num_buckets">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">num_buckets</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.num_buckets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of buckets into which metrics are retained. Max 128.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.rolling_window">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">rolling_window</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.rolling_window" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds in the statistical rolling window that metrics are retained for.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.tripped_duration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tripped_duration</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.tripped_duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCircuitBreaker.volume_threshold">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">volume_threshold</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCircuitBreaker.volume_threshold" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointCompression">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointCompression</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointCompression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointCompression" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointCompression.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointCompression.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointConfiguration</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointConfiguration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.circuit_breaker">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">circuit_breaker</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.circuit_breaker" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>circuit breaker module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointCircuitBreaker" title="ngrok.datatypes.EndpointCircuitBreaker"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCircuitBreaker</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.compression">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">compression</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.compression" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>compression module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointCompression" title="ngrok.datatypes.EndpointCompression"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointCompression</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the endpoint configuration was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointConfiguration.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier of this endpoint configuration</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.ip_policy">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policy</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.ip_policy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ip policy module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointIPPolicy" title="ngrok.datatypes.EndpointIPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointIPPolicy</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.logging">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">logging</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.logging" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>logging module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointLogging" title="ngrok.datatypes.EndpointLogging"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointLogging</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.mutual_tls">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">mutual_tls</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.mutual_tls" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>mutual TLS module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointMutualTLS" title="ngrok.datatypes.EndpointMutualTLS"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointMutualTLS</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.oauth">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">oauth</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.oauth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>oauth module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuth" title="ngrok.datatypes.EndpointOAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuth</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.oidc">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">oidc</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.oidc" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>oidc module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOIDC" title="ngrok.datatypes.EndpointOIDC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOIDC</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.request_headers">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">request_headers</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.request_headers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>request headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointRequestHeaders" title="ngrok.datatypes.EndpointRequestHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointRequestHeaders</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.response_headers">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">response_headers</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.response_headers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>response headers module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointResponseHeaders" title="ngrok.datatypes.EndpointResponseHeaders"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointResponseHeaders</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.saml">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">saml</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.saml" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>saml module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointSAML" title="ngrok.datatypes.EndpointSAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointSAML</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.tls_termination">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tls_termination</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.tls_termination" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>TLS termination module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointTLSTermination" title="ngrok.datatypes.EndpointTLSTermination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointTLSTermination</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>they type of traffic this endpoint configuration can be applied to. one of: <code class="docutils literal notranslate"><span class="pre">http</span></code>, <code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">tcp</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.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">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>, <em class="sig-param"><span class="n"><span class="pre">circuit_breaker</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">compression</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">request_headers</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">response_headers</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">ip_policy</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">mutual_tls</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">tls_termination</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">webhook_validation</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">oauth</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">logging</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">saml</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">oidc</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/datatypes.html#EndpointConfiguration.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the endpoint configuration API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfiguration.webhook_validation">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">webhook_validation</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfiguration.webhook_validation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>webhook validation module configuration or <code class="docutils literal notranslate"><span class="pre">null</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointWebhookValidation" title="ngrok.datatypes.EndpointWebhookValidation"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointWebhookValidation</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointConfigurationList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointConfigurationList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointConfigurationList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointConfigurationList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfigurationList.endpoint_configurations">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoint_configurations</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfigurationList.endpoint_configurations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all endpoint configurations on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EndpointConfiguration" title="ngrok.datatypes.EndpointConfiguration"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointConfiguration</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfigurationList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfigurationList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointConfigurationList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointConfigurationList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the endpoint configurations list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicy">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointIPPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointIPPolicy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicy.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicy.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicy.ip_policies">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policies</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicy.ip_policies" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicyMutate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointIPPolicyMutate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointIPPolicyMutate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicyMutate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicyMutate.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicyMutate.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointIPPolicyMutate.ip_policy_ids">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policy_ids</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointIPPolicyMutate.ip_policy_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of all IP policies that will be used to check if a source IP is allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointLogging">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointLogging</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointLogging"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointLogging" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointLogging.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointLogging.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointLogging.event_streams">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_streams</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointLogging.event_streams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of all EventStreams that will be used to configure and export this endpoint’s logs</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointLoggingMutate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointLoggingMutate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointLoggingMutate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointLoggingMutate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointLoggingMutate.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointLoggingMutate.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointLoggingMutate.event_stream_ids">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_stream_ids</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointLoggingMutate.event_stream_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of all EventStreams that will be used to configure and export this endpoint’s logs</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLS">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointMutualTLS</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointMutualTLS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLS.certificate_authorities">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_authorities</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLS.certificate_authorities" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLS.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLS.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLSMutate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointMutualTLSMutate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointMutualTLSMutate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLSMutate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLSMutate.certificate_authority_ids">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_authority_ids</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLSMutate.certificate_authority_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of certificate authorities that will be used to validate the TLS client certificate presnted by the initiatiator of the TLS connection</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointMutualTLSMutate.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointMutualTLSMutate.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuth">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuth</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuth"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.auth_check_interval">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth_check_interval</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.auth_check_interval" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.cookie_prefix">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cookie_prefix</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.cookie_prefix" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is ‘ngrok.’</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.inactivity_timeout">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">inactivity_timeout</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.inactivity_timeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.maximum_duration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">maximum_duration</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.maximum_duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.options_passthrough">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuth.provider">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">provider</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuth.provider" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>an object which defines the identity provider to use for authentication and configuration for who may access the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuthProvider" title="ngrok.datatypes.EndpointOAuthProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthProvider</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuthFacebook</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuthFacebook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook.client_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook.client_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client ID. retrieve it from the identity provider’s dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook.client_secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook.client_secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client secret. retrieve if from the identity provider’s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for <code class="docutils literal notranslate"><span class="pre">client_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook.email_addresses">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_addresses</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook.email_addresses" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook.email_domains">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_domains</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook.email_domains" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email domains of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthFacebook.scopes">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">scopes</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthFacebook.scopes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both <code class="docutils literal notranslate"><span class="pre">client_id</span></code> and <code class="docutils literal notranslate"><span class="pre">client_secret</span></code> to set scopes)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuthGitHub</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuthGitHub"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.client_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.client_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client ID. retrieve it from the identity provider’s dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.client_secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.client_secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client secret. retrieve if from the identity provider’s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for <code class="docutils literal notranslate"><span class="pre">client_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.email_addresses">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_addresses</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.email_addresses" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.email_domains">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_domains</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.email_domains" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email domains of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.organizations">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">organizations</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.organizations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization’s ‘slug’</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.scopes">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">scopes</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.scopes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both <code class="docutils literal notranslate"><span class="pre">client_id</span></code> and <code class="docutils literal notranslate"><span class="pre">client_secret</span></code> to set scopes)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGitHub.teams">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">teams</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitHub.teams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the ‘slug’ format qualified with the org name, e.g. <code class="docutils literal notranslate"><span class="pre">org-name/team-name</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuthGoogle</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuthGoogle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle.client_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle.client_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client ID. retrieve it from the identity provider’s dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle.client_secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle.client_secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client secret. retrieve if from the identity provider’s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for <code class="docutils literal notranslate"><span class="pre">client_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle.email_addresses">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_addresses</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle.email_addresses" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle.email_domains">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_domains</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle.email_domains" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email domains of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthGoogle.scopes">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">scopes</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGoogle.scopes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both <code class="docutils literal notranslate"><span class="pre">client_id</span></code> and <code class="docutils literal notranslate"><span class="pre">client_secret</span></code> to set scopes)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuthMicrosoft</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuthMicrosoft"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft.client_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft.client_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client ID. retrieve it from the identity provider’s dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft.client_secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft.client_secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the OAuth app client secret. retrieve if from the identity provider’s dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for <code class="docutils literal notranslate"><span class="pre">client_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft.email_addresses">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_addresses</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft.email_addresses" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft.email_domains">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email_domains</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft.email_domains" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of email domains of users authenticated by identity provider who are allowed access to the endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthMicrosoft.scopes">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">scopes</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthMicrosoft.scopes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both <code class="docutils literal notranslate"><span class="pre">client_id</span></code> and <code class="docutils literal notranslate"><span class="pre">client_secret</span></code> to set scopes)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOAuthProvider">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOAuthProvider</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOAuthProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthProvider.facebook">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">facebook</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.facebook" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>configuration for using facebook as the identity provider</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuthFacebook" title="ngrok.datatypes.EndpointOAuthFacebook"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthFacebook</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthProvider.github">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">github</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.github" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>configuration for using github as the identity provider</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuthGitHub" title="ngrok.datatypes.EndpointOAuthGitHub"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthGitHub</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthProvider.google">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">google</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.google" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>configuration for using google as the identity provider</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuthGoogle" title="ngrok.datatypes.EndpointOAuthGoogle"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthGoogle</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOAuthProvider.microsoft">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">microsoft</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.microsoft" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>configuration for using microsoft as the identity provider</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EndpointOAuthMicrosoft" title="ngrok.datatypes.EndpointOAuthMicrosoft"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthMicrosoft</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointOIDC">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointOIDC</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointOIDC"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.client_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.client_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The OIDC app’s client ID and OIDC audience.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.client_secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">client_secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.client_secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The OIDC app’s client secret.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.cookie_prefix">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cookie_prefix</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.cookie_prefix" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is ‘ngrok.’</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.inactivity_timeout">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">inactivity_timeout</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.inactivity_timeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.issuer">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">issuer</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.issuer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URL of the OIDC “OpenID provider”. This is the base URL used for discovery.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.maximum_duration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">maximum_duration</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.maximum_duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.options_passthrough">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointOIDC.scopes">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">scopes</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOIDC.scopes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The set of scopes to request from the OIDC identity provider.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointRequestHeaders">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointRequestHeaders</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointRequestHeaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointRequestHeaders" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointRequestHeaders.add">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">add</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointRequestHeaders.add" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointRequestHeaders.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointRequestHeaders.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointRequestHeaders.remove">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">remove</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointRequestHeaders.remove" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of header names that will be removed from the HTTP Request before being sent to the upstream application server</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointResponseHeaders">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointResponseHeaders</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointResponseHeaders"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointResponseHeaders" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointResponseHeaders.add">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">add</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointResponseHeaders.add" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointResponseHeaders.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointResponseHeaders.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointResponseHeaders.remove">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">remove</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointResponseHeaders.remove" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a list of header names that will be removed from the HTTP Response returned to the HTTP client</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointSAML">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointSAML</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointSAML"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointSAML" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.allow_idp_initiated">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">allow_idp_initiated</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.allow_idp_initiated" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the <code class="docutils literal notranslate"><span class="pre">RelayState</span></code> parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.assertion_consumer_service_url">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">assertion_consumer_service_url</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.assertion_consumer_service_url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The public URL of the SP’s Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.authorized_groups">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">authorized_groups</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.authorized_groups" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If present, only users who are a member of one of the listed groups may access the target endpoint.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.cookie_prefix">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cookie_prefix</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.cookie_prefix" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is ‘ngrok.’</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.entity_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">entity_id</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.entity_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The SP Entity’s unique ID. This always takes the form of a URL. In ngrok’s implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.force_authn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">force_authn</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.force_authn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.idp_metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">idp_metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.idp_metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.inactivity_timeout">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">inactivity_timeout</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.inactivity_timeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.maximum_duration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">maximum_duration</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.maximum_duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.metadata_url">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata_url</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.metadata_url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A public URL where the SP’s metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.nameid_format">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">nameid_format</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.nameid_format" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code class="docutils literal notranslate"><span class="pre">urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</span></code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.options_passthrough">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.request_signing_certificate_pem">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">request_signing_certificate_pem</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.request_signing_certificate_pem" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP’s configuration if it is supported.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAML.single_logout_url">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">single_logout_url</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAML.single_logout_url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The public URL of the SP’s Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointSAMLMutate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointSAMLMutate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.allow_idp_initiated">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">allow_idp_initiated</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.allow_idp_initiated" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the <code class="docutils literal notranslate"><span class="pre">RelayState</span></code> parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.authorized_groups">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">authorized_groups</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.authorized_groups" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If present, only users who are a member of one of the listed groups may access the target endpoint.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.cookie_prefix">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cookie_prefix</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.cookie_prefix" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is ‘ngrok.’</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.force_authn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">force_authn</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.force_authn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.idp_metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">idp_metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.idp_metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.inactivity_timeout">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">inactivity_timeout</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.inactivity_timeout" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.maximum_duration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">maximum_duration</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.maximum_duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.nameid_format">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">nameid_format</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.nameid_format" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code class="docutils literal notranslate"><span class="pre">urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</span></code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointSAMLMutate.options_passthrough">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">options_passthrough</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointSAMLMutate.options_passthrough" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointTLSTermination">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointTLSTermination</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointTLSTermination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointTLSTermination" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointTLSTermination.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointTLSTermination.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointTLSTermination.min_version">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">min_version</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointTLSTermination.min_version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if <code class="docutils literal notranslate"><span class="pre">terminate_at</span></code> is set to <code class="docutils literal notranslate"><span class="pre">upstream</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointTLSTermination.terminate_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">terminate_at</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointTLSTermination.terminate_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">edge</span></code> if the ngrok edge should terminate TLS traffic, <code class="docutils literal notranslate"><span class="pre">upstream</span></code> if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if <code class="docutils literal notranslate"><span class="pre">upstream</span></code> is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EndpointWebhookValidation">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EndpointWebhookValidation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EndpointWebhookValidation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointWebhookValidation.enabled">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enabled</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation.enabled" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the module will be applied to traffic, <code class="docutils literal notranslate"><span class="pre">false</span></code> to disable. default <code class="docutils literal notranslate"><span class="pre">true</span></code> if unspecified</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointWebhookValidation.provider">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">provider</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation.provider" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: <code class="docutils literal notranslate"><span class="pre">SLACK</span></code>, <code class="docutils literal notranslate"><span class="pre">SNS</span></code>, <code class="docutils literal notranslate"><span class="pre">STRIPE</span></code>, <code class="docutils literal notranslate"><span class="pre">GITHUB</span></code>, <code class="docutils literal notranslate"><span class="pre">TWILIO</span></code>, <code class="docutils literal notranslate"><span class="pre">SHOPIFY</span></code>, <code class="docutils literal notranslate"><span class="pre">GITLAB</span></code>, <code class="docutils literal notranslate"><span class="pre">INTERCOM</span></code>, <code class="docutils literal notranslate"><span class="pre">SENDGRID</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EndpointWebhookValidation.secret">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">secret</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointWebhookValidation.secret" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventDestination">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventDestination</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventDestination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventDestination" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Timestamp when the Event Destination was created, RFC 3339 format.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventDestination.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventDestination.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Human-readable description of the Event Destination. Optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.format">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">format</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.format" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is <code class="docutils literal notranslate"><span class="pre">JSON</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Unique identifier for this Event Destination.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.target">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">target</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.target" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: <code class="docutils literal notranslate"><span class="pre">kinesis</span></code>, <code class="docutils literal notranslate"><span class="pre">firehose</span></code>, <code class="docutils literal notranslate"><span class="pre">cloudwatch_logs</span></code>, or <code class="docutils literal notranslate"><span class="pre">s3</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EventTarget" title="ngrok.datatypes.EventTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTarget</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestination.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestination.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Destination API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventDestinationList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventDestinationList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventDestinationList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventDestinationList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestinationList.event_destinations">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_destinations</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestinationList.event_destinations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of all Event Destinations on this account.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EventDestination" title="ngrok.datatypes.EventDestination"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventDestination</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestinationList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestinationList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventDestinationList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventDestinationList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Destinations list API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventSource">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSource</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSource"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSource" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSource.type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.EventSource.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type of event for which an event subscription will trigger</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSource.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSource.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Source API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventSourceList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSourceList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSourceList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSourceList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSourceList.sources">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">sources</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceList.sources" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of all Event Sources for an Event Subscription</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSourceList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventSourceReplace">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSourceReplace</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSourceReplace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSourceReplace" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSourceReplace.type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.EventSourceReplace.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Type of event for which an event subscription will trigger</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventStream">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventStream</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventStream"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventStream" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Timestamp when the Event Stream was created, RFC 3339 format.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventStream.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventStream.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.destination_ids">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">destination_ids</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.destination_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.event_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_type</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.event_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The protocol that determines which events will be collected. Supported values are <code class="docutils literal notranslate"><span class="pre">tcp_connection_closed</span></code> and <code class="docutils literal notranslate"><span class="pre">http_request_complete</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.fields">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">fields</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A list of protocol-specific fields you want to collect on each event.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Unique identifier for this Event Stream.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.sampling_rate">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">sampling_rate</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.sampling_rate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.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">metadata</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">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">fields</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">destination_ids</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">sampling_rate</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/datatypes.html#EventStream.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventStream.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStream.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventStream.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Stream API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventStreamList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventStreamList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventStreamList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventStreamList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStreamList.event_streams">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_streams</span></code><a class="headerlink" href="#ngrok.datatypes.EventStreamList.event_streams" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of all Event Streams on this account.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStreamList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventStreamList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventStreamList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventStreamList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Stream list API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventSubscription">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSubscription</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSubscription"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscription" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>When the Event Subscription was created (RFC 3339 format).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSubscription.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscription.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.destinations">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">destinations</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.destinations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Destinations to which these events will be sent</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Unique identifier for this Event Subscription.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.sources">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">sources</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.sources" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sources containing the types for which this event subscription will trigger</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EventSource" title="ngrok.datatypes.EventSource"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSource</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscription.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscription.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Subscription API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventSubscriptionList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventSubscriptionList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventSubscriptionList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscriptionList.event_subscriptions">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">event_subscriptions</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.event_subscriptions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of all Event Subscriptions on this account.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.EventSubscription" title="ngrok.datatypes.EventSubscription"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventSubscription</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscriptionList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of next page, or null if there is no next page.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventSubscriptionList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.EventSubscriptionList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the Event Subscriptions list API resource.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventTarget">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventTarget</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventTarget"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventTarget" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTarget.cloudwatch_logs">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cloudwatch_logs</span></code><a class="headerlink" href="#ngrok.datatypes.EventTarget.cloudwatch_logs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration used to send events to Amazon CloudWatch Logs.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EventTargetCloudwatchLogs" title="ngrok.datatypes.EventTargetCloudwatchLogs"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTargetCloudwatchLogs</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTarget.firehose">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">firehose</span></code><a class="headerlink" href="#ngrok.datatypes.EventTarget.firehose" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration used to send events to Amazon Kinesis Data Firehose.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EventTargetFirehose" title="ngrok.datatypes.EventTargetFirehose"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTargetFirehose</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTarget.kinesis">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">kinesis</span></code><a class="headerlink" href="#ngrok.datatypes.EventTarget.kinesis" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration used to send events to Amazon Kinesis.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.EventTargetKinesis" title="ngrok.datatypes.EventTargetKinesis"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventTargetKinesis</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventTargetCloudwatchLogs">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventTargetCloudwatchLogs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventTargetCloudwatchLogs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventTargetCloudwatchLogs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetCloudwatchLogs.auth">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetCloudwatchLogs.auth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration for how to authenticate into your AWS account. Exactly one of <code class="docutils literal notranslate"><span class="pre">role</span></code> or <code class="docutils literal notranslate"><span class="pre">creds</span></code> should be configured.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.AWSAuth" title="ngrok.datatypes.AWSAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">AWSAuth</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetCloudwatchLogs.log_group_arn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">log_group_arn</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetCloudwatchLogs.log_group_arn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventTargetFirehose">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventTargetFirehose</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventTargetFirehose"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventTargetFirehose" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetFirehose.auth">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetFirehose.auth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration for how to authenticate into your AWS account. Exactly one of <code class="docutils literal notranslate"><span class="pre">role</span></code> or <code class="docutils literal notranslate"><span class="pre">creds</span></code> should be configured.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.AWSAuth" title="ngrok.datatypes.AWSAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">AWSAuth</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetFirehose.delivery_stream_arn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">delivery_stream_arn</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetFirehose.delivery_stream_arn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.EventTargetKinesis">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">EventTargetKinesis</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#EventTargetKinesis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EventTargetKinesis" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetKinesis.auth">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">auth</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetKinesis.auth" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Configuration for how to authenticate into your AWS account. Exactly one of <code class="docutils literal notranslate"><span class="pre">role</span></code> or <code class="docutils literal notranslate"><span class="pre">creds</span></code> should be configured.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.AWSAuth" title="ngrok.datatypes.AWSAuth"><code class="xref py py-class docutils literal notranslate"><span class="pre">AWSAuth</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.EventTargetKinesis.stream_arn">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">stream_arn</span></code><a class="headerlink" href="#ngrok.datatypes.EventTargetKinesis.stream_arn" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An Amazon Resource Name specifying the Kinesis stream to deposit events into.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPPolicy">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.action">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">action</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.action" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the IP policy action. Supported values are <code class="docutils literal notranslate"><span class="pre">allow</span></code> or <code class="docutils literal notranslate"><span class="pre">deny</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the IP policy was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicy.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicy.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this IP policy</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.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">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/datatypes.html#IPPolicy.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicy.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicy.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicy.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP Policy API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPPolicyList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPPolicyList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicyList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicyList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyList.ip_policies">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policies</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyList.ip_policies" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all IP policies on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.IPPolicy" title="ngrok.datatypes.IPPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicy</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP policy list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPPolicyRule">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPPolicyRule</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicyRule"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.cidr">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cidr</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.cidr" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the IP policy rule was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicyRule.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of the source IPs of this IP rule. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this IP policy rule</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.ip_policy">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policy</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.ip_policy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object describing the IP policy this IP Policy Rule belongs to</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.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">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>, <em class="sig-param"><span class="n"><span class="pre">cidr</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/datatypes.html#IPPolicyRule.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRule.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRule.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP policy rule API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPPolicyRuleList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPPolicyRuleList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPPolicyRuleList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPPolicyRuleList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRuleList.ip_policy_rules">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policy_rules</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRuleList.ip_policy_rules" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all IP policy rules on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.IPPolicyRule" title="ngrok.datatypes.IPPolicyRule"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPPolicyRule</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRuleList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRuleList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPPolicyRuleList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPPolicyRuleList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP policy rule list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPRestriction">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPRestriction</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPRestriction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPRestriction" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the IP restriction was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPRestriction.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPRestriction.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this IP restriction. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.enforced">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">enforced</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.enforced" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>true if the IP restriction will be enforced. if false, only warnings will be issued</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this IP restriction</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.ip_policies">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_policies</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.ip_policies" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the set of IP policies that are used to enforce the restriction</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: <code class="docutils literal notranslate"><span class="pre">dashboard</span></code>, <code class="docutils literal notranslate"><span class="pre">api</span></code>, <code class="docutils literal notranslate"><span class="pre">agent</span></code>, and <code class="docutils literal notranslate"><span class="pre">endpoints</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestriction.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestriction.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP restriction API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPRestrictionList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPRestrictionList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPRestrictionList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPRestrictionList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestrictionList.ip_restrictions">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_restrictions</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestrictionList.ip_restrictions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all IP restrictions on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.IPRestriction" title="ngrok.datatypes.IPRestriction"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPRestriction</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestrictionList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestrictionList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPRestrictionList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPRestrictionList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP resrtrictions list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPWhitelistEntry</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPWhitelistEntry"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the IP whitelist entry was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPWhitelistEntry.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this IP whitelist entry</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.ip_net">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_net</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.ip_net" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.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">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/datatypes.html#IPWhitelistEntry.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntry.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntry.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP whitelist entry API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntryList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">IPWhitelistEntryList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#IPWhitelistEntryList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntryList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntryList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntryList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntryList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntryList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the IP whitelist API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.IPWhitelistEntryList.whitelist">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">whitelist</span></code><a class="headerlink" href="#ngrok.datatypes.IPWhitelistEntryList.whitelist" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all IP whitelist entries on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.IPWhitelistEntry" title="ngrok.datatypes.IPWhitelistEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPWhitelistEntry</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.Ref">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">Ref</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Ref"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Ref" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.Ref.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.Ref.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Ref.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.Ref.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a uri for locating a resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedAddr">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedAddr</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedAddr"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedAddr" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.addr">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">addr</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.addr" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hostname:port of the reserved address that was assigned at creation time</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the reserved address was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedAddr.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of what this reserved address will be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.endpoint_configuration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoint_configuration</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.endpoint_configuration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object reference to the endpoint configuration that will be applied to traffic to this address</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique reserved address resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.region">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">region</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.region" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddr.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddr.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the reserved address API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedAddrList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedAddrList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedAddrList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedAddrList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddrList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddrList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddrList.reserved_addrs">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reserved_addrs</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddrList.reserved_addrs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all reserved addresses on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.ReservedAddr" title="ngrok.datatypes.ReservedAddr"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedAddr</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedAddrList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedAddrList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the reserved address list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomain">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomain</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomain"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomain" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.certificate">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.certificate_management_policy">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_management_policy</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.certificate_management_policy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.ReservedDomainCertPolicy" title="ngrok.datatypes.ReservedDomainCertPolicy"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertPolicy</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.certificate_management_status">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_management_status</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.certificate_management_status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>status of the automatic certificate management for this domain, or null if automatic management is disabled</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.ReservedDomainCertStatus" title="ngrok.datatypes.ReservedDomainCertStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertStatus</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.cname_target">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">cname_target</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.cname_target" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of <a href="#id1"><span class="problematic" id="id2">*</span></a>.ngrok.io</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the reserved domain was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomain.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of what this reserved domain will be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.domain">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">domain</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.domain" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>hostname of the reserved domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.http_endpoint_configuration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">http_endpoint_configuration</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.http_endpoint_configuration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object referencing the endpoint configuration applied to http traffic on this domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.https_endpoint_configuration">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">https_endpoint_configuration</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.https_endpoint_configuration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>object referencing the endpoint configuration applied to https traffic on this domain</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique reserved domain resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.region">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">region</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.region" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomain.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomain.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the reserved domain API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainCertJob</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomainCertJob"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob.error_code">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">error_code</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob.error_code" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob.msg">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">msg</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob.msg" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a message describing the current status or error</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob.ns_targets">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ns_targets</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob.ns_targets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>if present, indicates the dns nameservers that the user must configure to complete the provisioning process of a wildcard certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.ReservedDomainCertNSTarget" title="ngrok.datatypes.ReservedDomainCertNSTarget"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertNSTarget</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob.retries_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">retries_at</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob.retries_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the provisioning job will be retried</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertJob.started_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">started_at</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertJob.started_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the provisioning job started, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertNSTarget">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainCertNSTarget</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomainCertNSTarget"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertNSTarget" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertNSTarget.nameservers">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">nameservers</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertNSTarget.nameservers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the nameservers the user must add</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertNSTarget.zone">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">zone</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertNSTarget.zone" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the zone that the nameservers need to be applied to</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertPolicy">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainCertPolicy</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomainCertPolicy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertPolicy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertPolicy.authority">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">authority</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertPolicy.authority" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>certificate authority to request certificates from. The only supported value is letsencrypt.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertPolicy.private_key_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">private_key_type</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertPolicy.private_key_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertStatus">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainCertStatus</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomainCertStatus"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertStatus" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertStatus.provisioning_job">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">provisioning_job</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertStatus.provisioning_job" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>status of the certificate provisioning job, or null if the certificiate isn’t being provisioned or renewed</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.ReservedDomainCertJob" title="ngrok.datatypes.ReservedDomainCertJob"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomainCertJob</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainCertStatus.renews_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">renews_at</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertStatus.renews_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the next renewal will be requested, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.ReservedDomainList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">ReservedDomainList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#ReservedDomainList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ReservedDomainList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainList.reserved_domains">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">reserved_domains</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainList.reserved_domains" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all reserved domains on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.ReservedDomain" title="ngrok.datatypes.ReservedDomain"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReservedDomain</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.ReservedDomainList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.ReservedDomainList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the reserved domain list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHCertificateAuthority</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCertificateAuthority"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCertificateAuthority.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this SSH Certificate Authority. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this SSH Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.key_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">key_type</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.key_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the type of private key for this SSH Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.public_key">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">public_key</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.public_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>raw public key for this SSH Certificate Authority</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.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">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/datatypes.html#SSHCertificateAuthority.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthority.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthority.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the SSH Certificate Authority API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthorityList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHCertificateAuthorityList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCertificateAuthorityList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthorityList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthorityList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthorityList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthorityList.ssh_certificate_authorities">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_certificate_authorities</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthorityList.ssh_certificate_authorities" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all certificate authorities on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.SSHCertificateAuthority" title="ngrok.datatypes.SSHCertificateAuthority"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHCertificateAuthority</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCertificateAuthorityList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCertificateAuthorityList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the certificates authorities list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHCredential">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHCredential</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCredential"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCredential" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.acl">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">acl</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.acl" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the ssh credential was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCredential.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCredential.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique ssh credential resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.public_key">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">public_key</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.public_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.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">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>, <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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCredential.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCredential.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredential.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the ssh credential API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHCredentialList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHCredentialList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHCredentialList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHCredentialList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredentialList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredentialList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredentialList.ssh_credentials">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_credentials</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredentialList.ssh_credentials" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all ssh credentials on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#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>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHCredentialList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredentialList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the ssh credential list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHHostCertificate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHHostCertificate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.certificate">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a <code class="docutils literal notranslate"><span class="pre">-cert.pub</span></code> certificate file on disk that should be referenced in your <code class="docutils literal notranslate"><span class="pre">sshd_config</span></code> configuration file with a <code class="docutils literal notranslate"><span class="pre">HostCertificate</span></code> directive</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the SSH Host Certificate API resource was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHHostCertificate.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this SSH Host Certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.key_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">key_type</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.key_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the key type of the <code class="docutils literal notranslate"><span class="pre">public_key</span></code>, one of <code class="docutils literal notranslate"><span class="pre">rsa</span></code>, <code class="docutils literal notranslate"><span class="pre">ecdsa</span></code> or <code class="docutils literal notranslate"><span class="pre">ed25519</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.principals">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">principals</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.principals" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.public_key">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">public_key</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.public_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.ssh_certificate_authority_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_certificate_authority_id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.ssh_certificate_authority_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the ssh certificate authority that is used to sign this ssh host certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.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">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/datatypes.html#SSHHostCertificate.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the SSH Host Certificate API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.valid_after">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">valid_after</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.valid_after" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the time when the ssh host certificate becomes valid, in RFC 3339 format.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificate.valid_until">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">valid_until</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificate.valid_until" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this <code class="docutils literal notranslate"><span class="pre">valid_before</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHHostCertificateList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHHostCertificateList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHHostCertificateList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificateList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificateList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificateList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificateList.ssh_host_certificates">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_host_certificates</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificateList.ssh_host_certificates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all ssh host certificates on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.SSHHostCertificate" title="ngrok.datatypes.SSHHostCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">SSHHostCertificate</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHHostCertificateList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHHostCertificateList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the ssh host certificates list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHUserCertificate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHUserCertificate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.certificate">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.certificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a <code class="docutils literal notranslate"><span class="pre">-cert.pub</span></code> certificate file on disk that should be referenced in your <code class="docutils literal notranslate"><span class="pre">sshd_config</span></code> configuration file with a <code class="docutils literal notranslate"><span class="pre">HostCertificate</span></code> directive</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the SSH User Certificate API resource was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.critical_options">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">critical_options</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.critical_options" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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 <cite>the OpenSSH certificate protocol spec</cite> <<a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys</a>>`_ for additional details.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHUserCertificate.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this SSH User Certificate. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.extensions">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">extensions</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.extensions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><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 <cite>the OpenSSH certificate protocol spec</cite> <<a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys</a>>`_ for additional details.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this SSH User Certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.key_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">key_type</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.key_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the key type of the <code class="docutils literal notranslate"><span class="pre">public_key</span></code>, one of <code class="docutils literal notranslate"><span class="pre">rsa</span></code>, <code class="docutils literal notranslate"><span class="pre">ecdsa</span></code> or <code class="docutils literal notranslate"><span class="pre">ed25519</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.principals">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">principals</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.principals" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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 authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.public_key">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">public_key</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.public_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.ssh_certificate_authority_id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_certificate_authority_id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.ssh_certificate_authority_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the ssh certificate authority that is used to sign this ssh user certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.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">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/datatypes.html#SSHUserCertificate.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the SSH User Certificate API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.valid_after">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">valid_after</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.valid_after" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the time when the ssh host certificate becomes valid, in RFC 3339 format.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificate.valid_until">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">valid_until</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificate.valid_until" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this <code class="docutils literal notranslate"><span class="pre">valid_before</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.SSHUserCertificateList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">SSHUserCertificateList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#SSHUserCertificateList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificateList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificateList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificateList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.SSHUserCertificateList.ssh_user_certificates">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ssh_user_certificates</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificateList.ssh_user_certificates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all ssh user certificates on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#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.datatypes.SSHUserCertificateList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.SSHUserCertificateList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the ssh user certificates list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TLSCertificate">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TLSCertificate</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSCertificate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSCertificate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.certificate_pem">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">certificate_pem</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.certificate_pem" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>chain of PEM-encoded certificates, leaf first. See <cite>Certificate Bundles</cite> <<a class="reference external" href="https://ngrok.com/docs/api#tls-certificates-pem">https://ngrok.com/docs/api#tls-certificates-pem</a>>`_.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.created_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">created_at</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.created_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the TLS certificate was created, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.delete">
|
||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSCertificate.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.description">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">description</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>human-readable description of this TLS certificate. optional, max 255 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.extended_key_usages">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">extended_key_usages</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.extended_key_usages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>extended set of actions the private key of this TLS certificate can be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique identifier for this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.issued_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">issued_at</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.issued_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.issuer_common_name">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">issuer_common_name</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.issuer_common_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>issuer common name from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.key_usages">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">key_usages</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.key_usages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>set of actions the private key of this TLS certificate can be used for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.not_after">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">not_after</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.not_after" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when this TLS certificate becomes invalid, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.not_before">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">not_before</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.not_before" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when this TLS certificate becomes valid, RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.private_key_type">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">private_key_type</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.private_key_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.serial_number">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">serial_number</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.serial_number" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>serial number of the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_alternative_names">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_alternative_names</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_alternative_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject alternative names (SANs) from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.TLSCertificateSANs" title="ngrok.datatypes.TLSCertificateSANs"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificateSANs</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_common_name">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_common_name</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_common_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject common name from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_country">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_country</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_country" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject country from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_locality">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_locality</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_locality" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject locality from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_organization">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_organization</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_organization" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject organization from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_organizational_unit">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_organizational_unit</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_organizational_unit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject organizational unit from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.subject_province">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">subject_province</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.subject_province" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>subject province from the leaf of this TLS certificate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.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">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/datatypes.html#TLSCertificate.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificate.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificate.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the TLS certificate API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TLSCertificateList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TLSCertificateList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSCertificateList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSCertificateList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificateList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificateList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificateList.tls_certificates">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tls_certificates</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificateList.tls_certificates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all TLS certificates on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.TLSCertificate" title="ngrok.datatypes.TLSCertificate"><code class="xref py py-class docutils literal notranslate"><span class="pre">TLSCertificate</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificateList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificateList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the TLS certificates list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TLSCertificateSANs">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TLSCertificateSANs</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TLSCertificateSANs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TLSCertificateSANs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificateSANs.dns_names">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">dns_names</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificateSANs.dns_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>set of additional domains (including wildcards) this TLS certificate is valid for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TLSCertificateSANs.ips">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ips</span></code><a class="headerlink" href="#ngrok.datatypes.TLSCertificateSANs.ips" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>set of IP addresses this TLS certificate is also valid for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><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>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.Tunnel">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">Tunnel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Tunnel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Tunnel" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique tunnel resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel <cite>metadata configuration option</cite> <<a class="reference external" href="https://ngrok.com/docs#tunnel-definitions-metadata">https://ngrok.com/docs#tunnel-definitions-metadata</a>>`_ In API version 0, this value was instead pulled from the top-level <cite>metadata configuration option</cite> <<a class="reference external" href="https://ngrok.com/docs#config_metadata">https://ngrok.com/docs#config_metadata</a>>`_.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.proto">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">proto</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.proto" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>tunnel protocol. one of <code class="docutils literal notranslate"><span class="pre">http</span></code>, <code class="docutils literal notranslate"><span class="pre">https</span></code>, <code class="docutils literal notranslate"><span class="pre">tcp</span></code> or <code class="docutils literal notranslate"><span class="pre">tls</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.public_url">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">public_url</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.public_url" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URL of the tunnel’s public endpoint</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.region">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">region</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.region" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>identifier of tune region where the tunnel is running</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.started_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">started_at</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.started_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timestamp when the tunnel was initiated in RFC 3339 format</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.Tunnel.tunnel_session">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tunnel_session</span></code><a class="headerlink" href="#ngrok.datatypes.Tunnel.tunnel_session" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>reference object pointing to the tunnel session on which this tunnel was started</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TunnelList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TunnelList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TunnelList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TunnelList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelList.tunnels">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tunnels</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelList.tunnels" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the list of all online tunnels on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.Tunnel" title="ngrok.datatypes.Tunnel"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tunnel</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the tunnels list API resource</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TunnelSession">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TunnelSession</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TunnelSession"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TunnelSession" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.agent_version">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">agent_version</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.agent_version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>version of the ngrok agent that started this ngrok tunnel session</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.credential">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">credential</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.credential" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.id">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">id</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>unique tunnel session resource identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.ip">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.ip" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>source ip address of the tunnel session</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.metadata">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">metadata</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.metadata" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.os">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">os</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.os" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>operating system of the host the ngrok agent is running on</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.region">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">region</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.region" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the ngrok region identifier in which this tunnel session was started</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.started_at">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">started_at</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.started_at" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>time when the tunnel session first connected to the ngrok servers</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.transport">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">transport</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.transport" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>the transport protocol used to start the tunnel session. Either <code class="docutils literal notranslate"><span class="pre">ngrok/v2</span></code> or <code class="docutils literal notranslate"><span class="pre">ssh</span></code></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSession.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSession.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI to the API resource of the tunnel session</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt id="ngrok.datatypes.TunnelSessionList">
|
||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></code><code class="sig-name descname"><span class="pre">TunnelSessionList</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#TunnelSessionList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.TunnelSessionList" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSessionList.next_page_uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">next_page_uri</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSessionList.next_page_uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI of the next page, or null if there is no next page</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSessionList.tunnel_sessions">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">tunnel_sessions</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSessionList.tunnel_sessions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of all tunnel sessions on this account</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<a class="reference internal" href="#ngrok.datatypes.TunnelSession" title="ngrok.datatypes.TunnelSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">TunnelSession</span></code></a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt id="ngrok.datatypes.TunnelSessionList.uri">
|
||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">uri</span></code><a class="headerlink" href="#ngrok.datatypes.TunnelSessionList.uri" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>URI to the API resource of the tunnel session list</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
</div>
|
||
|
||
</article>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="errors.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Errors</div>
|
||
</div>
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="client.html">
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">Client</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="related-information">
|
||
Copyright © 2021, 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/datatypes.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> |