mirror of
https://github.com/ngrok/ngrok-api-python.git
synced 2026-05-17 16:50:36 +00:00
Update generated files
This commit is contained in:
ngrok release bot
Executable
Vendored
BIN
Binary file not shown.
Executable
@@ -0,0 +1,64 @@
|
||||
action: GLOB, msg: packaging
|
||||
cwd: /var/lib/buildkite-agent-3/builds/ip-172-31-58-32-us-west-2-compute-internal-3-1/ngrok/api-client-prs/.cache/ngrok-api-python
|
||||
cmd: /var/lib/buildkite-agent-3/builds/ip-172-31-58-32-us-west-2-compute-internal-3-1/ngrok/api-client-prs/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir /var/lib/buildkite-agent-3/builds/ip-172-31-58-32-us-west-2-compute-internal-3-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist
|
||||
running sdist
|
||||
running egg_info
|
||||
writing ngrok_api.egg-info/PKG-INFO
|
||||
writing dependency_links to ngrok_api.egg-info/dependency_links.txt
|
||||
writing requirements to ngrok_api.egg-info/requires.txt
|
||||
writing top-level names to ngrok_api.egg-info/top_level.txt
|
||||
reading manifest file 'ngrok_api.egg-info/SOURCES.txt'
|
||||
adding license file 'LICENSE'
|
||||
writing manifest file 'ngrok_api.egg-info/SOURCES.txt'
|
||||
running check
|
||||
creating ngrok-api-0.0.0
|
||||
creating ngrok-api-0.0.0/ngrok
|
||||
creating ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
creating ngrok-api-0.0.0/tests
|
||||
copying files to ngrok-api-0.0.0...
|
||||
copying LICENSE -> ngrok-api-0.0.0
|
||||
copying README.md -> ngrok-api-0.0.0
|
||||
copying pyproject.toml -> ngrok-api-0.0.0
|
||||
copying setup.py -> ngrok-api-0.0.0
|
||||
copying ngrok/__init__.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/client.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/datatypes.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/error.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/http_client.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/iterator.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/services.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok/utils.py -> ngrok-api-0.0.0/ngrok
|
||||
copying ngrok_api.egg-info/PKG-INFO -> ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
copying ngrok_api.egg-info/SOURCES.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
copying ngrok_api.egg-info/dependency_links.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
copying ngrok_api.egg-info/requires.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
copying ngrok_api.egg-info/top_level.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
|
||||
copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests
|
||||
Writing ngrok-api-0.0.0/setup.cfg
|
||||
creating /var/lib/buildkite-agent-3/builds/ip-172-31-58-32-us-west-2-compute-internal-3-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist
|
||||
creating '/var/lib/buildkite-agent-3/builds/ip-172-31-58-32-us-west-2-compute-internal-3-1/ngrok/api-client-prs/.cache/ngrok-api-python/.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it
|
||||
adding 'ngrok-api-0.0.0'
|
||||
adding 'ngrok-api-0.0.0/tests'
|
||||
adding 'ngrok-api-0.0.0/ngrok'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info'
|
||||
adding 'ngrok-api-0.0.0/PKG-INFO'
|
||||
adding 'ngrok-api-0.0.0/pyproject.toml'
|
||||
adding 'ngrok-api-0.0.0/README.md'
|
||||
adding 'ngrok-api-0.0.0/LICENSE'
|
||||
adding 'ngrok-api-0.0.0/setup.cfg'
|
||||
adding 'ngrok-api-0.0.0/setup.py'
|
||||
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/http_client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/utils.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/error.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/iterator.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/services.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/client.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
|
||||
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt'
|
||||
removing 'ngrok-api-0.0.0' (and everything under it)
|
||||
@@ -9,6 +9,10 @@ This library is published on [PyPi](https://pypi.org/project/ngrok-api/):
|
||||
|
||||
pip install ngrok-api
|
||||
|
||||
## Support
|
||||
|
||||
The best place to get support using this library is through the [ngrok Slack Community](https://ngrok.com/slack). If you find any bugs, please contribute by opening a new GitHub issue.
|
||||
|
||||
## Documentation
|
||||
|
||||
A quickstart guide and a full API reference are included in the [ngrok python API documentation](https://python-api.docs.ngrok.com).
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
Application Sessions
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.application_sessions` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ApplicationSessionsClient
|
||||
:undoc-members: ApplicationSessionsClient
|
||||
@@ -0,0 +1,9 @@
|
||||
Application Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.application_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ApplicationUsersClient
|
||||
:undoc-members: ApplicationUsersClient
|
||||
@@ -123,6 +123,8 @@ API Reference
|
||||
abuse_reports
|
||||
agent_ingresses
|
||||
api_keys
|
||||
application_sessions
|
||||
application_users
|
||||
failover_backends
|
||||
http_response_backends
|
||||
tunnel_group_backends
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -190,7 +192,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">abuse_reports</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AbuseReportsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
|
||||
<span class="w"> </span><span class="sd">"""Abuse Reports allow you to submit take-down requests for URLs hosted by</span>
|
||||
<span class="sd"> ngrok that violate ngrok's terms of service."""</span>
|
||||
<span class="k">return</span> <span class="n">AbuseReportsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
@@ -200,16 +202,24 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">api_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">APIKeysClient</span><span class="p">:</span>
|
||||
<span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
|
||||
<span class="sd"> API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself</span>
|
||||
<span class="w"> </span><span class="sd">"""API Keys are used to authenticate to the `ngrok</span>
|
||||
<span class="sd"> API <https://ngrok.com/docs/api#authentication>`_. You may use the API itself</span>
|
||||
<span class="sd"> to provision and manage API Keys but you'll need to provision your first API</span>
|
||||
<span class="sd"> key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your</span>
|
||||
<span class="sd"> key from the `API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your</span>
|
||||
<span class="sd"> ngrok.com dashboard."""</span>
|
||||
<span class="k">return</span> <span class="n">APIKeysClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">application_sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ApplicationSessionsClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">ApplicationSessionsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">application_users</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ApplicationUsersClient</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">ApplicationUsersClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">CertificateAuthoritiesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
|
||||
<span class="w"> </span><span class="sd">"""Certificate Authorities are x509 certificates that are used to sign other</span>
|
||||
<span class="sd"> x509 certificates. Attach a Certificate Authority to the Mutual TLS module</span>
|
||||
<span class="sd"> to verify that the TLS certificate presented by a client has been signed by</span>
|
||||
<span class="sd"> this CA. Certificate Authorities are used only for mTLS validation only and</span>
|
||||
@@ -218,7 +228,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">CredentialsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
|
||||
<span class="w"> </span><span class="sd">"""Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</span>
|
||||
<span class="sd"> agent to connect the ngrok service as your account. They are installed with</span>
|
||||
<span class="sd"> the ``ngrok config add-authtoken`` command or by specifying it in the ``ngrok.yml``</span>
|
||||
<span class="sd"> configuration file with the ``authtoken`` property."""</span>
|
||||
@@ -226,7 +236,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EndpointsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Endpoints provides an API for querying the endpoint objects</span>
|
||||
<span class="w"> </span><span class="sd">"""Endpoints provides an API for querying the endpoint objects</span>
|
||||
<span class="sd"> which define what tunnel or edge is used to serve a hostport.</span>
|
||||
<span class="sd"> Only active endpoints associated with a tunnel or backend are returned."""</span>
|
||||
<span class="k">return</span> <span class="n">EndpointsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
@@ -245,7 +255,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ip_policies</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPPoliciesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
|
||||
<span class="w"> </span><span class="sd">"""IP Policies are reusable groups of CIDR ranges with an ``allow`` or ``deny``</span>
|
||||
<span class="sd"> action. They can be attached to endpoints via the Endpoint Configuration IP</span>
|
||||
<span class="sd"> Policy module. They can also be used with IP Restrictions to control source</span>
|
||||
<span class="sd"> IP ranges that can start tunnel sessions and connect to the API and dashboard."""</span>
|
||||
@@ -253,13 +263,13 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ip_policy_rules</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPPolicyRulesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
|
||||
<span class="w"> </span><span class="sd">"""IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</span>
|
||||
<span class="sd"> make up an IP Policy."""</span>
|
||||
<span class="k">return</span> <span class="n">IPPolicyRulesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ip_restrictions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">IPRestrictionsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
|
||||
<span class="w"> </span><span class="sd">"""An IP restriction is a restriction placed on the CIDRs that are allowed to</span>
|
||||
<span class="sd"> initiate traffic to a specific aspect of your ngrok account. An IP</span>
|
||||
<span class="sd"> restriction has a type which defines the ingress it applies to. IP</span>
|
||||
<span class="sd"> restrictions can be used to enforce the source IPs that can make API</span>
|
||||
@@ -269,14 +279,14 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">reserved_addrs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ReservedAddrsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
|
||||
<span class="w"> </span><span class="sd">"""Reserved Addresses are TCP addresses that can be used to listen for traffic.</span>
|
||||
<span class="sd"> TCP address hostnames and ports are assigned by ngrok, they cannot be</span>
|
||||
<span class="sd"> chosen."""</span>
|
||||
<span class="k">return</span> <span class="n">ReservedAddrsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">reserved_domains</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">ReservedDomainsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
|
||||
<span class="w"> </span><span class="sd">"""Reserved Domains are hostnames that you can listen for traffic on. Domains</span>
|
||||
<span class="sd"> can be used to listen for http, https or tls traffic. You may use a domain</span>
|
||||
<span class="sd"> that you own by creating a CNAME record specified in the returned resource.</span>
|
||||
<span class="sd"> This CNAME record points traffic for that domain to ngrok's edge servers."""</span>
|
||||
@@ -284,33 +294,33 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ssh_certificate_authorities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
<span class="w"> </span><span class="sd">"""An SSH Certificate Authority is a pair of an SSH Certificate and its private</span>
|
||||
<span class="sd"> key that can be used to sign other SSH host and user certificates."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHCertificateAuthoritiesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ssh_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHCredentialsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
|
||||
<span class="w"> </span><span class="sd">"""SSH Credentials are SSH public keys that can be used to start SSH tunnels</span>
|
||||
<span class="sd"> via the ngrok SSH tunnel gateway."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHCredentialsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ssh_host_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHHostCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
|
||||
<span class="w"> </span><span class="sd">"""SSH Host Certificates along with the corresponding private key allows an SSH</span>
|
||||
<span class="sd"> server to assert its authenticity to connecting SSH clients who trust the</span>
|
||||
<span class="sd"> SSH Certificate Authority that was used to sign the certificate."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHHostCertificatesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">ssh_user_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">SSHUserCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
|
||||
<span class="w"> </span><span class="sd">"""SSH User Certificates are presented by SSH clients when connecting to an SSH</span>
|
||||
<span class="sd"> server to authenticate their connection. The SSH server must trust the SSH</span>
|
||||
<span class="sd"> Certificate Authority used to sign the certificate."""</span>
|
||||
<span class="k">return</span> <span class="n">SSHUserCertificatesClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tls_certificates</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TLSCertificatesClient</span><span class="p">:</span>
|
||||
<span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
|
||||
<span class="w"> </span><span class="sd">"""TLS Certificates are pairs of x509 certificates and their matching private</span>
|
||||
<span class="sd"> key that can be used to terminate TLS traffic. TLS certificates are unused</span>
|
||||
<span class="sd"> until they are attached to a Domain. TLS Certificates may also be</span>
|
||||
<span class="sd"> provisioned by ngrok automatically for domains on which you have enabled</span>
|
||||
@@ -319,14 +329,14 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tunnel_sessions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TunnelSessionsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
|
||||
<span class="w"> </span><span class="sd">"""Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</span>
|
||||
<span class="sd"> sessions that are running and connected to the ngrok service. Each tunnel</span>
|
||||
<span class="sd"> session can include one or more Tunnels."""</span>
|
||||
<span class="k">return</span> <span class="n">TunnelSessionsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">tunnels</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">TunnelsClient</span><span class="p">:</span>
|
||||
<span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
|
||||
<span class="w"> </span><span class="sd">"""Tunnels provide endpoints to access services exposed by a running ngrok</span>
|
||||
<span class="sd"> agent tunnel session or an SSH reverse tunnel session."""</span>
|
||||
<span class="k">return</span> <span class="n">TunnelsClient</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
||||
|
||||
|
||||
+1071
-477
File diff suppressed because it is too large
Load Diff
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -182,7 +184,7 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Error"><a class="viewcode-back" href="../../errors.html#ngrok.Error">[docs]</a><span class="k">class</span> <span class="nc">Error</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
||||
<span class="sd">"""Raised by failed ngrok API operations.</span>
|
||||
<span class="w"> </span><span class="sd">"""Raised by failed ngrok API operations.</span>
|
||||
|
||||
<span class="sd"> This class encapsulates details about the error to make it simple for callers</span>
|
||||
<span class="sd"> to introspect the error and take action on it.</span>
|
||||
@@ -207,7 +209,7 @@
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span> <span class="nf">operation_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">"""</span>
|
||||
<span class="w"> </span><span class="sd">"""</span>
|
||||
<span class="sd"> OperationID returns the unique trace ID assigned by ngrok to this API</span>
|
||||
<span class="sd"> request.</span>
|
||||
<span class="sd"> """</span>
|
||||
@@ -215,7 +217,7 @@
|
||||
|
||||
|
||||
<div class="viewcode-block" id="NotFoundError"><a class="viewcode-back" href="../../errors.html#ngrok.NotFoundError">[docs]</a><span class="k">class</span> <span class="nc">NotFoundError</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
|
||||
<span class="sd">"""Raised if the http_status_code of an API operation is 404.</span>
|
||||
<span class="w"> </span><span class="sd">"""Raised if the http_status_code of an API operation is 404.</span>
|
||||
<span class="sd"> This is a separate class to make this common condition easier to handle.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
|
||||
+360
-225
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,9 @@
|
||||
Application Sessions
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.application_sessions` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ApplicationSessionsClient
|
||||
:undoc-members: ApplicationSessionsClient
|
||||
@@ -0,0 +1,9 @@
|
||||
Application Users
|
||||
=====================================
|
||||
|
||||
Do not construct this object directly, instead access the
|
||||
:attr:`~ngrok.Client.application_users` property of an :class:`ngrok.Client` object.
|
||||
|
||||
.. automodule:: ngrok.services
|
||||
:members: ApplicationUsersClient
|
||||
:undoc-members: ApplicationUsersClient
|
||||
@@ -123,6 +123,8 @@ API Reference
|
||||
abuse_reports
|
||||
agent_ingresses
|
||||
api_keys
|
||||
application_sessions
|
||||
application_users
|
||||
failover_backends
|
||||
http_response_backends
|
||||
tunnel_group_backends
|
||||
|
||||
Vendored
+28
-27
@@ -5,21 +5,21 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #404040 }
|
||||
.highlight { background: #202020; color: #d0d0d0 }
|
||||
.highlight .c { color: #999999; font-style: italic } /* Comment */
|
||||
.highlight .c { color: #ababab; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
||||
.highlight .esc { color: #d0d0d0 } /* Escape */
|
||||
.highlight .g { color: #d0d0d0 } /* Generic */
|
||||
.highlight .k { color: #6ab825; font-weight: bold } /* Keyword */
|
||||
.highlight .k { color: #6ebf26; font-weight: bold } /* Keyword */
|
||||
.highlight .l { color: #d0d0d0 } /* Literal */
|
||||
.highlight .n { color: #d0d0d0 } /* Name */
|
||||
.highlight .o { color: #d0d0d0 } /* Operator */
|
||||
.highlight .x { color: #d0d0d0 } /* Other */
|
||||
.highlight .p { color: #d0d0d0 } /* Punctuation */
|
||||
.highlight .ch { color: #999999; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #999999; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #999999; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #999999; font-style: italic } /* Comment.Single */
|
||||
.highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */
|
||||
.highlight .gd { color: #d22323 } /* Generic.Deleted */
|
||||
.highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */
|
||||
@@ -31,36 +31,37 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
|
||||
.highlight .gs { color: #d0d0d0; font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #ffffff; text-decoration: underline } /* Generic.Subheading */
|
||||
.highlight .gt { color: #d22323 } /* Generic.Traceback */
|
||||
.highlight .kc { color: #6ab825; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #6ab825; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #6ab825; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #6ab825 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #6ab825; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #6ab825; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .kc { color: #6ebf26; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #6ebf26; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #6ebf26; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #6ebf26 } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #6ebf26; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #6ebf26; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .ld { color: #d0d0d0 } /* Literal.Date */
|
||||
.highlight .m { color: #3677a9 } /* Literal.Number */
|
||||
.highlight .m { color: #51b2fd } /* Literal.Number */
|
||||
.highlight .s { color: #ed9d13 } /* Literal.String */
|
||||
.highlight .na { color: #bbbbbb } /* Name.Attribute */
|
||||
.highlight .nb { color: #24909d } /* Name.Builtin */
|
||||
.highlight .nc { color: #447fcf; text-decoration: underline } /* Name.Class */
|
||||
.highlight .nb { color: #2fbccd } /* Name.Builtin */
|
||||
.highlight .nc { color: #71adff; text-decoration: underline } /* Name.Class */
|
||||
.highlight .no { color: #40ffff } /* Name.Constant */
|
||||
.highlight .nd { color: #ffa500 } /* Name.Decorator */
|
||||
.highlight .ni { color: #d0d0d0 } /* Name.Entity */
|
||||
.highlight .ne { color: #bbbbbb } /* Name.Exception */
|
||||
.highlight .nf { color: #447fcf } /* Name.Function */
|
||||
.highlight .nf { color: #71adff } /* Name.Function */
|
||||
.highlight .nl { color: #d0d0d0 } /* Name.Label */
|
||||
.highlight .nn { color: #447fcf; text-decoration: underline } /* Name.Namespace */
|
||||
.highlight .nn { color: #71adff; text-decoration: underline } /* Name.Namespace */
|
||||
.highlight .nx { color: #d0d0d0 } /* Name.Other */
|
||||
.highlight .py { color: #d0d0d0 } /* Name.Property */
|
||||
.highlight .nt { color: #6ab825; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nt { color: #6ebf26; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #40ffff } /* Name.Variable */
|
||||
.highlight .ow { color: #6ab825; font-weight: bold } /* Operator.Word */
|
||||
.highlight .ow { color: #6ebf26; font-weight: bold } /* Operator.Word */
|
||||
.highlight .pm { color: #d0d0d0 } /* Punctuation.Marker */
|
||||
.highlight .w { color: #666666 } /* Text.Whitespace */
|
||||
.highlight .mb { color: #3677a9 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #3677a9 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #3677a9 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #3677a9 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #3677a9 } /* Literal.Number.Oct */
|
||||
.highlight .mb { color: #51b2fd } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #51b2fd } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #51b2fd } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #51b2fd } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #51b2fd } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #ed9d13 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #ed9d13 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #ed9d13 } /* Literal.String.Char */
|
||||
@@ -74,10 +75,10 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
|
||||
.highlight .sr { color: #ed9d13 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #ed9d13 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #ed9d13 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #24909d } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #447fcf } /* Name.Function.Magic */
|
||||
.highlight .bp { color: #2fbccd } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #71adff } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #40ffff } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #40ffff } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #40ffff } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #40ffff } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #3677a9 } /* Literal.Number.Integer.Long */
|
||||
.highlight .il { color: #51b2fd } /* Literal.Number.Integer.Long */
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
+10
-7
@@ -2,7 +2,7 @@
|
||||
<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="Failover Backends" href="failover_backends.html" /><link rel="prev" title="Agent Ingresses" href="agent_ingresses.html" />
|
||||
<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="Application Sessions" href="application_sessions.html" /><link rel="prev" title="Agent Ingresses" href="agent_ingresses.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>API Keys - ngrok-api documentation</title>
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -184,20 +186,21 @@
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.APIKeysClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">APIKeysClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#APIKeysClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>API Keys are used to authenticate to the <cite>ngrok
|
||||
API</cite> <<a class="reference external" href="https://ngrok.com/docs/api#authentication">https://ngrok.com/docs/api#authentication</a>>`_. You may use the API itself
|
||||
<dd><p>API Keys are used to authenticate to the <a class="reference external" href="https://ngrok.com/docs/api#authentication">ngrok
|
||||
API</a>. You may use the API itself
|
||||
to provision and manage API Keys but you’ll need to provision your first API
|
||||
key from the <cite>API Keys page</cite> <<a class="reference external" href="https://dashboard.ngrok.com/api/keys">https://dashboard.ngrok.com/api/keys</a>>`_ on your
|
||||
key from the <a class="reference external" href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your
|
||||
ngrok.com dashboard.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.APIKeysClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#APIKeysClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#APIKeysClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.APIKeysClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new API key. The generated API key can be used to authenticate to the ngrok API.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined data of this API key. optional, max 4096 bytes</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -281,12 +284,12 @@ ngrok.com dashboard.</p>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="failover_backends.html">
|
||||
<a class="next-page" href="application_sessions.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Failover Backends</div>
|
||||
<div class="title">Application Sessions</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
@@ -0,0 +1,292 @@
|
||||
<!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="Application Users" href="application_users.html" /><link rel="prev" title="API Keys" href="api_keys.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Application Sessions - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" href="_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
||||
<link rel="stylesheet" href="_static/pygments.css">
|
||||
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
:root {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/* For allowing end-user-specific overrides */
|
||||
.override-light {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
.override-dark {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
</style><link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
||||
<body dir="">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||||
<line x1="4" y1="6" x2="20" y2="6" />
|
||||
<line x1="10" y1="12" x2="20" y2="12" />
|
||||
<line x1="6" y1="18" x2="20" y2="18" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html">
|
||||
<input class="sidebar-search" placeholder=Search name="q">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><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="application-sessions">
|
||||
<h1>Application Sessions<a class="headerlink" href="#application-sessions" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.application_sessions" title="ngrok.Client.application_sessions"><code class="xref py py-attr docutils literal notranslate"><span class="pre">application_sessions</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.ApplicationSessionsClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">ApplicationSessionsClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationSessionsClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationSessionsClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationSessionsClient.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationSessionsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationSessionsClient.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete an application session by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-sessions-delete">https://ngrok.com/docs/api#api-application-sessions-delete</a></p>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationSessionsClient.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationSessionsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationSessionsClient.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get an application session by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-sessions-get">https://ngrok.com/docs/api#api-application-sessions-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ApplicationSession" title="ngrok.datatypes.ApplicationSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationSession</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationSessionsClient.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationSessionsClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationSessionsClient.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all application sessions for this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-sessions-list">https://ngrok.com/docs/api#api-application-sessions-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ApplicationSessionList" title="ngrok.datatypes.ApplicationSessionList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationSessionList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
</div>
|
||||
|
||||
</article>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="application_users.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Application Users</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="api_keys.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">API Keys</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="related-information">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
|
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
|
||||
and
|
||||
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
||||
|
|
||||
<a class="muted-link" href="_sources/application_sessions.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>
|
||||
@@ -0,0 +1,292 @@
|
||||
<!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="Failover Backends" href="failover_backends.html" /><link rel="prev" title="Application Sessions" href="application_sessions.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Application Users - ngrok-api documentation</title>
|
||||
<link rel="stylesheet" href="_static/styles/furo.css?digest=59ab60ac09ea94ccfe6deddff6d715cce948a6fc">
|
||||
<link rel="stylesheet" href="_static/pygments.css">
|
||||
<link media="(prefers-color-scheme: dark)" rel="stylesheet" href="_static/pygments_dark.css">
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
:root {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/* For allowing end-user-specific overrides */
|
||||
.override-light {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
.override-dark {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
</style><link rel="stylesheet" href="_static/styles/furo-extensions.css?digest=d391b54134226e4196576da3bdb6dddb7e05ba2b"></head>
|
||||
<body dir="">
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke-width="1.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round">
|
||||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||||
<line x1="4" y1="6" x2="20" y2="6" />
|
||||
<line x1="10" y1="12" x2="20" y2="12" />
|
||||
<line x1="6" y1="18" x2="20" y2="18" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||||
class="feather feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||||
<label class="overlay toc-overlay" for="__toc"></label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">ngrok-api documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">ngrok-api documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html">
|
||||
<input class="sidebar-search" placeholder=Search name="q">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption"><span class="caption-text">API</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Services</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="weighted_backends.html">Weighted Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="certificate_authorities.html">Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="credentials.html">Tunnel Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https_routes.html">HTTPS Edge Routes</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_https.html">HTTPS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_mutual_tls_module.html">HTTPS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="https_edge_tls_termination_module.html">HTTPS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_backend_module.html">HTTPS Edge Route Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_ip_restriction_module.html">HTTPS Edge Route IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_request_headers_module.html">HTTPS Edge Route Request Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_response_headers_module.html">HTTPS Edge Route Response Headers Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_compression_module.html">HTTPS Edge Route Compression Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_circuit_breaker_module.html">HTTPS Edge Route Circuit Breaker Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_webhook_verification_module.html">HTTPS Edge Route Webhook Verification Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_o_auth_module.html">HTTPS Edge Route OAuth Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_saml_module.html">HTTPS Edge Route SAML Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_oidc_module.html">HTTPS Edge Route OIDC Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edge_route_websocket_tcp_converter_module.html">HTTPS Edge Route Websocket TCP Converter Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tcp.html">TCP Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_backend_module.html">TCP Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tcp_edge_ip_restriction_module.html">TCP Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="edges_tls.html">TLS Edges</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_backend_module.html">TLS Edge Backend Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_ip_restriction_module.html">TLS Edge IP Restriction Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_mutual_tls_module.html">TLS Edge Mutual TLS Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tls_edge_tls_termination_module.html">TLS Edge TLS Termination Module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_destinations.html">Event Destinations</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_subscriptions.html">Event Subscriptions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="event_sources.html">Event Sources</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policies.html">IP Policies</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_policy_rules.html">IP Policy Rules</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ip_restrictions.html">IP Restrictions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_addrs.html">Reserved Addresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reserved_domains.html">Reserved Domains</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_certificate_authorities.html">SSH Certificate Authorities</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_credentials.html">SSH Credentials</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ssh_host_certificates.html">SSH Host Certificates</a></li>
|
||||
<li class="toctree-l1"><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="application-users">
|
||||
<h1>Application Users<a class="headerlink" href="#application-users" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Do not construct this object directly, instead access the
|
||||
<a class="reference internal" href="client.html#ngrok.Client.application_users" title="ngrok.Client.application_users"><code class="xref py py-attr docutils literal notranslate"><span class="pre">application_users</span></code></a> property of an <a class="reference internal" href="client.html#ngrok.Client" title="ngrok.Client"><code class="xref py py-class docutils literal notranslate"><span class="pre">ngrok.Client</span></code></a> object.</p>
|
||||
<span class="target" id="module-ngrok.services"></span><dl class="py class">
|
||||
<dt id="ngrok.services.ApplicationUsersClient">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">ngrok.services.</span></code><code class="sig-name descname"><span class="pre">ApplicationUsersClient</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationUsersClient"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationUsersClient" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationUsersClient.delete">
|
||||
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationUsersClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationUsersClient.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Delete an application user by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-users-delete">https://ngrok.com/docs/api#api-application-users-delete</a></p>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationUsersClient.get">
|
||||
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationUsersClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationUsersClient.get" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get an application user by ID.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-users-get">https://ngrok.com/docs/api#api-application-users-get</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ApplicationUser" title="ngrok.datatypes.ApplicationUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationUser</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ApplicationUsersClient.list">
|
||||
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">before_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ApplicationUsersClient.list"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ApplicationUsersClient.list" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>List all application users for this account.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>before_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="https://ngrok.com/docs/api#api-application-users-list">https://ngrok.com/docs/api#api-application-users-list</a></p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.ApplicationUserList" title="ngrok.datatypes.ApplicationUserList"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationUserList</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
</div>
|
||||
|
||||
</article>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="failover_backends.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Failover Backends</div>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="application_sessions.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Application Sessions</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<div class="related-information">
|
||||
Copyright © 1980, ngrok Inc.
|
||||
|
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a>
|
||||
and
|
||||
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
||||
|
|
||||
<a class="muted-link" href="_sources/application_users.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>
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
+23
-3
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -222,10 +224,10 @@ ngrok that violate ngrok’s terms of service.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.api_keys">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">api_keys</span></code><a class="headerlink" href="#ngrok.Client.api_keys" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>API Keys are used to authenticate to the <cite>ngrok
|
||||
API</cite> <<a class="reference external" href="https://ngrok.com/docs/api#authentication">https://ngrok.com/docs/api#authentication</a>>`_. You may use the API itself
|
||||
<dd><p>API Keys are used to authenticate to the <a class="reference external" href="https://ngrok.com/docs/api#authentication">ngrok
|
||||
API</a>. You may use the API itself
|
||||
to provision and manage API Keys but you’ll need to provision your first API
|
||||
key from the <cite>API Keys page</cite> <<a class="reference external" href="https://dashboard.ngrok.com/api/keys">https://dashboard.ngrok.com/api/keys</a>>`_ on your
|
||||
key from the <a class="reference external" href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your
|
||||
ngrok.com dashboard.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
@@ -234,6 +236,24 @@ ngrok.com dashboard.</p>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.application_sessions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_sessions</span></code><a class="headerlink" href="#ngrok.Client.application_sessions" 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><a class="reference internal" href="application_sessions.html#ngrok.services.ApplicationSessionsClient" title="ngrok.services.ApplicationSessionsClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationSessionsClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.application_users">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_users</span></code><a class="headerlink" href="#ngrok.Client.application_users" 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><a class="reference internal" href="application_users.html#ngrok.services.ApplicationUsersClient" title="ngrok.services.ApplicationUsersClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationUsersClient</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.Client.backends">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">backends</span></code><a class="headerlink" href="#ngrok.Client.backends" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -190,14 +192,15 @@ the <code class="docutils literal notranslate"><span class="pre">ngrok</span> <s
|
||||
configuration file with the <code class="docutils literal notranslate"><span class="pre">authtoken</span></code> property.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.CredentialsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#CredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.CredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -264,7 +267,7 @@ configuration file with the <code class="docutils literal notranslate"><span cla
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
+740
-12
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -228,6 +230,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.APIKey.owner_id">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">owner_id</span></code><a class="headerlink" href="#ngrok.datatypes.APIKey.owner_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -573,6 +585,334 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.ApplicationSession">
|
||||
<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">ApplicationSession</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#ApplicationSession"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationSession" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationSession.application_user">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_user</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.application_user" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>application user this session is associated with</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.ApplicationSession.browser_session">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">browser_session</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.browser_session" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>browser session details of the application 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.BrowserSession" title="ngrok.datatypes.BrowserSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">BrowserSession</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationSession.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.ApplicationSession.created_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when the user 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.ApplicationSession.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#ApplicationSession.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationSession.edge">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">edge</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.edge" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>edge this session is associated with, null if the endpoint is agent-initiated</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.ApplicationSession.endpoint">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">endpoint</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.endpoint" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>ephemeral endpoint this session is associated with</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.ApplicationSession.expires_at">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">expires_at</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.expires_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when session expires 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.ApplicationSession.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.ApplicationSession.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>unique application 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.ApplicationSession.last_active">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">last_active</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.last_active" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when the user was last active 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.ApplicationSession.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.ApplicationSession.public_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URL of the hostport served by this 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.ApplicationSession.route">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">route</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSession.route" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>route this session is associated with, null if the endpoint is agent-initiated</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.ApplicationSession.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.ApplicationSession.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the application session 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.ApplicationSessionList">
|
||||
<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">ApplicationSessionList</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#ApplicationSessionList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationSessionList" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationSessionList.application_sessions">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_sessions</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationSessionList.application_sessions" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>list of all application 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.ApplicationSession" title="ngrok.datatypes.ApplicationSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationSession</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationSessionList.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.ApplicationSessionList.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.ApplicationSessionList.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.ApplicationSessionList.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the application session 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.ApplicationUser">
|
||||
<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">ApplicationUser</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#ApplicationUser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationUser" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationUser.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.ApplicationUser.created_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when the user 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.ApplicationUser.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#ApplicationUser.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationUser.email">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">email</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.email" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>user email</p>
|
||||
<dl class="field-list simple">
|
||||
<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.ApplicationUser.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.ApplicationUser.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>unique application user 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.ApplicationUser.identity_provider">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">identity_provider</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.identity_provider" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>identity provider that the user authenticated with</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.IdentityProvider" title="ngrok.datatypes.IdentityProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">IdentityProvider</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationUser.last_active">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">last_active</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.last_active" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when the user was last active 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.ApplicationUser.last_login">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">last_login</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.last_login" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>timestamp when the user last signed-in 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.ApplicationUser.name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>user common name</p>
|
||||
<dl class="field-list simple">
|
||||
<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.ApplicationUser.provider_user_id">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">provider_user_id</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.provider_user_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>unique user 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.ApplicationUser.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.ApplicationUser.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the application user 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.ApplicationUser.username">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">username</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUser.username" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>user username</p>
|
||||
<dl class="field-list simple">
|
||||
<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.ApplicationUserList">
|
||||
<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">ApplicationUserList</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#ApplicationUserList"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.ApplicationUserList" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationUserList.application_users">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">application_users</span></code><a class="headerlink" href="#ngrok.datatypes.ApplicationUserList.application_users" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>list of all application users 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.ApplicationUser" title="ngrok.datatypes.ApplicationUser"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApplicationUser</span></code></a>]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.ApplicationUserList.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.ApplicationUserList.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.ApplicationUserList.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.ApplicationUserList.uri" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URI of the application user 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.BrowserSession">
|
||||
<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">BrowserSession</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#BrowserSession"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.BrowserSession" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.BrowserSession.ip_address">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">ip_address</span></code><a class="headerlink" href="#ngrok.datatypes.BrowserSession.ip_address" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>IP address</p>
|
||||
<dl class="field-list simple">
|
||||
<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.BrowserSession.location">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">location</span></code><a class="headerlink" href="#ngrok.datatypes.BrowserSession.location" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>IP geolocation data</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.Location" title="ngrok.datatypes.Location"><code class="xref py py-class docutils literal notranslate"><span class="pre">Location</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.BrowserSession.user_agent">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">user_agent</span></code><a class="headerlink" href="#ngrok.datatypes.BrowserSession.user_agent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>HTTP User-Agent data</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.UserAgent" title="ngrok.datatypes.UserAgent"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserAgent</span></code></a></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">
|
||||
@@ -734,7 +1074,7 @@
|
||||
<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>
|
||||
<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, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -786,6 +1126,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.Credential.owner_id">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">owner_id</span></code><a class="headerlink" href="#ngrok.datatypes.Credential.owner_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
||||
<dl class="field-list simple">
|
||||
<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 agent. <strong>This value is only available one time, on the API response from credential creation, otherwise it is null.</strong></p>
|
||||
@@ -1075,7 +1425,7 @@
|
||||
<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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">timedelta</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1282,7 +1632,7 @@
|
||||
<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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">timedelta</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1308,6 +1658,55 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthAmazon">
|
||||
<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">EndpointOAuthAmazon</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#EndpointOAuthAmazon"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthAmazon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthAmazon.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.EndpointOAuthAmazon.client_id" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthAmazon.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.EndpointOAuthAmazon.client_secret" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthAmazon.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.EndpointOAuthAmazon.email_addresses" 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>[<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.EndpointOAuthAmazon.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.EndpointOAuthAmazon.email_domains" 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>[<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.EndpointOAuthAmazon.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.EndpointOAuthAmazon.scopes" 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>[<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.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">
|
||||
@@ -1436,6 +1835,55 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthGitLab">
|
||||
<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">EndpointOAuthGitLab</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#EndpointOAuthGitLab"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthGitLab" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthGitLab.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.EndpointOAuthGitLab.client_id" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthGitLab.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.EndpointOAuthGitLab.client_secret" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthGitLab.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.EndpointOAuthGitLab.email_addresses" 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>[<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.EndpointOAuthGitLab.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.EndpointOAuthGitLab.email_domains" 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>[<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.EndpointOAuthGitLab.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.EndpointOAuthGitLab.scopes" 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>[<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">
|
||||
@@ -1490,6 +1938,55 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthLinkedIn">
|
||||
<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">EndpointOAuthLinkedIn</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#EndpointOAuthLinkedIn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthLinkedIn" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthLinkedIn.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.EndpointOAuthLinkedIn.client_id" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthLinkedIn.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.EndpointOAuthLinkedIn.client_secret" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthLinkedIn.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.EndpointOAuthLinkedIn.email_addresses" 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>[<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.EndpointOAuthLinkedIn.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.EndpointOAuthLinkedIn.email_domains" 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>[<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.EndpointOAuthLinkedIn.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.EndpointOAuthLinkedIn.scopes" 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>[<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">
|
||||
@@ -1547,6 +2044,16 @@
|
||||
<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.amazon">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">amazon</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.amazon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>configuration for using amazon 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.EndpointOAuthAmazon" title="ngrok.datatypes.EndpointOAuthAmazon"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthAmazon</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<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>
|
||||
@@ -1567,6 +2074,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthProvider.gitlab">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">gitlab</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.gitlab" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>configuration for using gitlab 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.EndpointOAuthGitLab" title="ngrok.datatypes.EndpointOAuthGitLab"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthGitLab</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>
|
||||
@@ -1577,6 +2094,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthProvider.linkedin">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">linkedin</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.linkedin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>configuration for using linkedin 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.EndpointOAuthLinkedIn" title="ngrok.datatypes.EndpointOAuthLinkedIn"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthLinkedIn</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>
|
||||
@@ -1586,6 +2113,65 @@
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthProvider.twitch">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">twitch</span></code><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthProvider.twitch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>configuration for using twitch 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.EndpointOAuthTwitch" title="ngrok.datatypes.EndpointOAuthTwitch"><code class="xref py py-class docutils literal notranslate"><span class="pre">EndpointOAuthTwitch</span></code></a></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthTwitch">
|
||||
<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">EndpointOAuthTwitch</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#EndpointOAuthTwitch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.EndpointOAuthTwitch" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthTwitch.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.EndpointOAuthTwitch.client_id" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthTwitch.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.EndpointOAuthTwitch.client_secret" 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">str</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.EndpointOAuthTwitch.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.EndpointOAuthTwitch.email_addresses" 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>[<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.EndpointOAuthTwitch.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.EndpointOAuthTwitch.email_domains" 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>[<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.EndpointOAuthTwitch.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.EndpointOAuthTwitch.scopes" 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>[<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.EndpointOIDC">
|
||||
@@ -1656,7 +2242,7 @@
|
||||
<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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">timedelta</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1848,7 +2434,7 @@
|
||||
<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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">timedelta</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1982,7 +2568,7 @@
|
||||
<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 class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">timedelta</span></code></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -2081,7 +2667,7 @@
|
||||
<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>, <code class="docutils literal notranslate"><span class="pre">XERO</span></code>, <code class="docutils literal notranslate"><span class="pre">PAGERDUTY</span></code>.</p>
|
||||
<dd><p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at <a class="reference external" href="https://ngrok.com/docs/cloud-edge/modules/webhook">https://ngrok.com/docs/cloud-edge/modules/webhook</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>
|
||||
@@ -3414,6 +4000,74 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.IdentityProvider">
|
||||
<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">IdentityProvider</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#IdentityProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.IdentityProvider" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.IdentityProvider.name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">name</span></code><a class="headerlink" href="#ngrok.datatypes.IdentityProvider.name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>name of the identity provider (e.g. Google)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.IdentityProvider.url">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">url</span></code><a class="headerlink" href="#ngrok.datatypes.IdentityProvider.url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>URL of the identity provider (e.g. <a class="reference external" href="https://accounts.google.com">https://accounts.google.com</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>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.Location">
|
||||
<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">Location</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#Location"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Location" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.Location.country_code">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">country_code</span></code><a class="headerlink" href="#ngrok.datatypes.Location.country_code" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>ISO country 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.Location.lat_long_radius_km">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">lat_long_radius_km</span></code><a class="headerlink" href="#ngrok.datatypes.Location.lat_long_radius_km" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>accuracy radius of the geographical coordinates</p>
|
||||
<dl class="field-list simple">
|
||||
<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.Location.latitude">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">latitude</span></code><a class="headerlink" href="#ngrok.datatypes.Location.latitude" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>geographical latitude</p>
|
||||
<dl class="field-list simple">
|
||||
<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.Location.longitude">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">longitude</span></code><a class="headerlink" href="#ngrok.datatypes.Location.longitude" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>geographical longitude</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
</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">
|
||||
@@ -3925,7 +4579,7 @@
|
||||
<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>
|
||||
<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, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -3977,6 +4631,16 @@
|
||||
</dl>
|
||||
</dd></dl>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.datatypes.SSHCredential.owner_id">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">owner_id</span></code><a class="headerlink" href="#ngrok.datatypes.SSHCredential.owner_id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -4227,7 +4891,7 @@
|
||||
<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>
|
||||
<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 <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -4251,7 +4915,7 @@
|
||||
<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>
|
||||
<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 <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
|
||||
<dl class="field-list simple">
|
||||
<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>
|
||||
@@ -4518,7 +5182,7 @@
|
||||
<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>
|
||||
<dd><p>chain of PEM-encoded certificates, leaf first. See <a class="reference external" href="https://ngrok.com/docs/api#tls-certificates-pem">Certificate Bundles</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>
|
||||
@@ -4991,7 +5655,7 @@
|
||||
<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>
|
||||
<dd><p>user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel <a class="reference external" href="https://ngrok.com/docs#tunnel-definitions-metadata">metadata configuration option</a> In API version 0, this value was instead pulled from the top-level <a class="reference external" href="https://ngrok.com/docs#config_metadata">metadata configuration option</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>
|
||||
@@ -5338,6 +6002,70 @@
|
||||
</dd></dl>
|
||||
</dd></dl>
|
||||
<dl class="py class">
|
||||
<dt id="ngrok.datatypes.UserAgent">
|
||||
<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">UserAgent</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#UserAgent"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.UserAgent" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.datatypes.UserAgent.browser_name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">browser_name</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.browser_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>browser name (e.g. Chrome)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.UserAgent.browser_version">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">browser_version</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.browser_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>browser version (e.g. 102)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.UserAgent.device_type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">device_type</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.device_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>type of device (e.g. Desktop)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.UserAgent.os_name">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">os_name</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.os_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>operating system name (e.g. MacOS)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.UserAgent.os_version">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">os_version</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.os_version" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>operating system version (e.g. 10.15.7)</p>
|
||||
<dl class="field-list simple">
|
||||
<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.UserAgent.raw">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">raw</span></code><a class="headerlink" href="#ngrok.datatypes.UserAgent.raw" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>raw User-Agent request header</p>
|
||||
<dl class="field-list simple">
|
||||
<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.WeightedBackend">
|
||||
<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">WeightedBackend</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#WeightedBackend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.WeightedBackend" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -187,7 +189,7 @@
|
||||
<dd><dl class="py method">
|
||||
<dt id="ngrok.services.EventDestinationsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EventDestinationsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EventDestinationsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.</p>
|
||||
<dd><p>Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
<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="HTTP Response Backends" href="http_response_backends.html" /><link rel="prev" title="API Keys" href="api_keys.html" />
|
||||
<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="HTTP Response Backends" href="http_response_backends.html" /><link rel="prev" title="Application Users" href="application_users.html" />
|
||||
|
||||
<meta name="generator" content="sphinx-3.5.4, furo 2021.04.11.beta34"/>
|
||||
<title>Failover Backends - ngrok-api documentation</title>
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -291,14 +293,14 @@ the next backend in the list until one is successful.</p>
|
||||
</div>
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="api_keys.html">
|
||||
<a class="prev-page" href="application_users.html">
|
||||
<svg><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">API Keys</div>
|
||||
<div class="title">Application Users</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
|
||||
+218
-16
@@ -117,6 +117,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -227,8 +229,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate.allow_idp_initiated">(ngrok.datatypes.EndpointSAMLMutate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.amazon">amazon() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.api_keys">api_keys() (ngrok.Client property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey">APIKey (class in ngrok.datatypes)</a>
|
||||
@@ -236,6 +238,34 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList">APIKeyList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient">APIKeysClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="client.html#ngrok.Client.application_sessions">application_sessions() (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSessionList.application_sessions">(ngrok.datatypes.ApplicationSessionList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.application_user">application_user() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.application_users">application_users() (ngrok.Client property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList.application_users">(ngrok.datatypes.ApplicationUserList property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession">ApplicationSession (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSessionList">ApplicationSessionList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient">ApplicationSessionsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser">ApplicationUser (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList">ApplicationUserList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient">ApplicationUsersClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.assertion_consumer_service_url">assertion_consumer_service_url() (ngrok.datatypes.EndpointSAML property)</a>
|
||||
</li>
|
||||
@@ -308,6 +338,14 @@
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend.body">body() (ngrok.datatypes.HTTPResponseBackend property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.browser_name">browser_name() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.browser_session">browser_session() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.browser_version">browser_version() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession">BrowserSession (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@@ -355,26 +393,42 @@
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client">Client (class in ngrok)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.client_id">client_id() (ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.client_id">client_id() (ngrok.datatypes.EndpointOAuthAmazon property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.client_id">(ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.client_id">(ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab.client_id">(ngrok.datatypes.EndpointOAuthGitLab property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle.client_id">(ngrok.datatypes.EndpointOAuthGoogle property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn.client_id">(ngrok.datatypes.EndpointOAuthLinkedIn property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft.client_id">(ngrok.datatypes.EndpointOAuthMicrosoft property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch.client_id">(ngrok.datatypes.EndpointOAuthTwitch property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC.client_id">(ngrok.datatypes.EndpointOIDC property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.client_secret">client_secret() (ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.client_secret">client_secret() (ngrok.datatypes.EndpointOAuthAmazon property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.client_secret">(ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.client_secret">(ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab.client_secret">(ngrok.datatypes.EndpointOAuthGitLab property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle.client_secret">(ngrok.datatypes.EndpointOAuthGoogle property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn.client_secret">(ngrok.datatypes.EndpointOAuthLinkedIn property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft.client_secret">(ngrok.datatypes.EndpointOAuthMicrosoft property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch.client_secret">(ngrok.datatypes.EndpointOAuthTwitch property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC.client_secret">(ngrok.datatypes.EndpointOIDC property)</a>
|
||||
</li>
|
||||
@@ -395,6 +449,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAMLMutate.cookie_prefix">(ngrok.datatypes.EndpointSAMLMutate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.country_code">country_code() (ngrok.datatypes.Location property)</a>
|
||||
</li>
|
||||
<li><a href="abuse_reports.html#ngrok.services.AbuseReportsClient.create">create() (ngrok.services.AbuseReportsClient method)</a>
|
||||
|
||||
<ul>
|
||||
@@ -457,6 +513,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngress.created_at">(ngrok.datatypes.AgentIngress property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.created_at">(ngrok.datatypes.APIKey property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.created_at">(ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.created_at">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.created_at">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -535,6 +595,10 @@
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.delete">(ngrok.datatypes.APIKey method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.delete">(ngrok.datatypes.ApplicationSession method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.delete">(ngrok.datatypes.ApplicationUser method)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.delete">(ngrok.datatypes.CertificateAuthority method)</a>
|
||||
</li>
|
||||
@@ -583,6 +647,10 @@
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient.delete">(ngrok.services.AgentIngressesClient method)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient.delete">(ngrok.services.APIKeysClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.delete">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.delete">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.delete">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -728,6 +796,8 @@
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventSubscription.destinations">destinations() (ngrok.datatypes.EventSubscription property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.device_type">device_type() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TLSCertificateSANs.dns_names">dns_names() (ngrok.datatypes.TLSCertificateSANs property)</a>
|
||||
</li>
|
||||
@@ -747,8 +817,12 @@
|
||||
<h2>E</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.edge">edge() (ngrok.datatypes.Endpoint property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.edge">edge() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.edge">(ngrok.datatypes.Endpoint property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.edge_id">edge_id() (ngrok.datatypes.HTTPSEdgeRoute property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.edge_modules">edge_modules() (ngrok.Client property)</a>
|
||||
@@ -785,24 +859,42 @@
|
||||
</li>
|
||||
<li><a href="edges_tls.html#ngrok.services.EdgesTLSClient">EdgesTLSClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.email_addresses">email_addresses() (ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.email">email() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.email_addresses">email_addresses() (ngrok.datatypes.EndpointOAuthAmazon property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.email_addresses">(ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.email_addresses">(ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab.email_addresses">(ngrok.datatypes.EndpointOAuthGitLab property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle.email_addresses">(ngrok.datatypes.EndpointOAuthGoogle property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn.email_addresses">(ngrok.datatypes.EndpointOAuthLinkedIn property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft.email_addresses">(ngrok.datatypes.EndpointOAuthMicrosoft property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch.email_addresses">(ngrok.datatypes.EndpointOAuthTwitch property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.email_domains">email_domains() (ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.email_domains">email_domains() (ngrok.datatypes.EndpointOAuthAmazon property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.email_domains">(ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.email_domains">(ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab.email_domains">(ngrok.datatypes.EndpointOAuthGitLab property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle.email_domains">(ngrok.datatypes.EndpointOAuthGoogle property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn.email_domains">(ngrok.datatypes.EndpointOAuthLinkedIn property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft.email_domains">(ngrok.datatypes.EndpointOAuthMicrosoft property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch.email_domains">(ngrok.datatypes.EndpointOAuthTwitch property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackend.enabled">enabled() (ngrok.datatypes.EndpointBackend property)</a>
|
||||
@@ -845,16 +937,20 @@
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint">Endpoint (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.endpoint">endpoint() (ngrok.datatypes.Tunnel property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.endpoint">endpoint() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.endpoint">(ngrok.datatypes.Tunnel property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackend">EndpointBackend (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointBackendMutate">EndpointBackendMutate (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker">EndpointCircuitBreaker (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCompression">EndpointCompression (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointIPPolicy">EndpointIPPolicy (class in ngrok.datatypes)</a>
|
||||
@@ -868,16 +964,24 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointMutualTLSMutate">EndpointMutualTLSMutate (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuth">EndpointOAuth (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon">EndpointOAuthAmazon (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook">EndpointOAuthFacebook (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub">EndpointOAuthGitHub (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab">EndpointOAuthGitLab (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle">EndpointOAuthGoogle (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn">EndpointOAuthLinkedIn (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft">EndpointOAuthMicrosoft (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider">EndpointOAuthProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch">EndpointOAuthTwitch (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC">EndpointOIDC (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
@@ -956,6 +1060,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetFirehose">EventTargetFirehose (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetKinesis">EventTargetKinesis (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.expires_at">expires_at() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.extended_key_usages">extended_key_usages() (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
|
||||
@@ -1009,6 +1115,10 @@
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient.get">(ngrok.services.AgentIngressesClient method)</a>
|
||||
</li>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient.get">(ngrok.services.APIKeysClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.get">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.get">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.get">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1104,6 +1214,8 @@
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.github">github() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.gitlab">gitlab() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.google">google() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
@@ -1165,6 +1277,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngress.id">(ngrok.datatypes.AgentIngress property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.id">(ngrok.datatypes.APIKey property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.id">(ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.id">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.id">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -1219,6 +1335,10 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.WeightedBackend.id">(ngrok.datatypes.WeightedBackend property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.identity_provider">identity_provider() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider">IdentityProvider (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.idp_metadata">idp_metadata() (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1240,6 +1360,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AgentIngressList.ingresses">ingresses() (ngrok.datatypes.AgentIngressList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.ip">ip() (ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession.ip_address">ip_address() (ngrok.datatypes.BrowserSession property)</a>
|
||||
</li>
|
||||
<li><a href="client.html#ngrok.Client.ip_policies">ip_policies() (ngrok.Client property)</a>
|
||||
|
||||
@@ -1343,10 +1465,28 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelGroupBackend.labels">(ngrok.datatypes.TunnelGroupBackend property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.last_active">last_active() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.last_active">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.last_login">last_login() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.lat_long_radius_km">lat_long_radius_km() (ngrok.datatypes.Location property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.latitude">latitude() (ngrok.datatypes.Location property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.linkedin">linkedin() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
<li><a href="agent_ingresses.html#ngrok.services.AgentIngressesClient.list">list() (ngrok.services.AgentIngressesClient method)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="api_keys.html#ngrok.services.APIKeysClient.list">(ngrok.services.APIKeysClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_sessions.html#ngrok.services.ApplicationSessionsClient.list">(ngrok.services.ApplicationSessionsClient method)</a>
|
||||
</li>
|
||||
<li><a href="application_users.html#ngrok.services.ApplicationUsersClient.list">(ngrok.services.ApplicationUsersClient method)</a>
|
||||
</li>
|
||||
<li><a href="certificate_authorities.html#ngrok.services.CertificateAuthoritiesClient.list">(ngrok.services.CertificateAuthoritiesClient method)</a>
|
||||
</li>
|
||||
@@ -1401,7 +1541,13 @@
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location">Location (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession.location">location() (ngrok.datatypes.BrowserSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EventTargetCloudwatchLogs.log_group_arn">log_group_arn() (ngrok.datatypes.EventTargetCloudwatchLogs property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Location.longitude">longitude() (ngrok.datatypes.Location property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
@@ -1503,7 +1649,7 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#module-ngrok.datatypes">ngrok.datatypes</a>
|
||||
</li>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="certificate_authorities.html#module-ngrok.services">[3]</a>, <a href="credentials.html#module-ngrok.services">[4]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[5]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[6]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[15]</a>, <a href="edges_https.html#module-ngrok.services">[16]</a>, <a href="edges_https_routes.html#module-ngrok.services">[17]</a>, <a href="edges_tcp.html#module-ngrok.services">[18]</a>, <a href="edges_tls.html#module-ngrok.services">[19]</a>, <a href="endpoints.html#module-ngrok.services">[20]</a>, <a href="event_destinations.html#module-ngrok.services">[21]</a>, <a href="event_sources.html#module-ngrok.services">[22]</a>, <a href="event_subscriptions.html#module-ngrok.services">[23]</a>, <a href="failover_backends.html#module-ngrok.services">[24]</a>, <a href="http_response_backends.html#module-ngrok.services">[25]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[26]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[27]</a>, <a href="ip_policies.html#module-ngrok.services">[28]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[29]</a>, <a href="ip_restrictions.html#module-ngrok.services">[30]</a>, <a href="reserved_addrs.html#module-ngrok.services">[31]</a>, <a href="reserved_domains.html#module-ngrok.services">[32]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[33]</a>, <a href="ssh_credentials.html#module-ngrok.services">[34]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[35]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[36]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[37]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[38]</a>, <a href="tls_certificates.html#module-ngrok.services">[39]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[40]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[41]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[43]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[44]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[45]</a>, <a href="tunnels.html#module-ngrok.services">[46]</a>, <a href="weighted_backends.html#module-ngrok.services">[47]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">ngrok.services</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="certificate_authorities.html#module-ngrok.services">[5]</a>, <a href="credentials.html#module-ngrok.services">[6]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[17]</a>, <a href="edges_https.html#module-ngrok.services">[18]</a>, <a href="edges_https_routes.html#module-ngrok.services">[19]</a>, <a href="edges_tcp.html#module-ngrok.services">[20]</a>, <a href="edges_tls.html#module-ngrok.services">[21]</a>, <a href="endpoints.html#module-ngrok.services">[22]</a>, <a href="event_destinations.html#module-ngrok.services">[23]</a>, <a href="event_sources.html#module-ngrok.services">[24]</a>, <a href="event_subscriptions.html#module-ngrok.services">[25]</a>, <a href="failover_backends.html#module-ngrok.services">[26]</a>, <a href="http_response_backends.html#module-ngrok.services">[27]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[28]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[29]</a>, <a href="ip_policies.html#module-ngrok.services">[30]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[31]</a>, <a href="ip_restrictions.html#module-ngrok.services">[32]</a>, <a href="reserved_addrs.html#module-ngrok.services">[33]</a>, <a href="reserved_domains.html#module-ngrok.services">[34]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[35]</a>, <a href="ssh_credentials.html#module-ngrok.services">[36]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[37]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[38]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[39]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[40]</a>, <a href="tls_certificates.html#module-ngrok.services">[41]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[43]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[44]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[45]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[46]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[47]</a>, <a href="tunnels.html#module-ngrok.services">[48]</a>, <a href="weighted_backends.html#module-ngrok.services">[49]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainCertJob.msg">msg() (ngrok.datatypes.ReservedDomainCertJob property)</a>
|
||||
@@ -1522,6 +1668,12 @@
|
||||
<h2>N</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.name">name() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.name">(ngrok.datatypes.IdentityProvider property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointSAML.nameid_format">nameid_format() (ngrok.datatypes.EndpointSAML property)</a>
|
||||
|
||||
<ul>
|
||||
@@ -1532,6 +1684,10 @@
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList.next_page_uri">(ngrok.datatypes.APIKeyList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSessionList.next_page_uri">(ngrok.datatypes.ApplicationSessionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList.next_page_uri">(ngrok.datatypes.ApplicationUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthorityList.next_page_uri">(ngrok.datatypes.CertificateAuthorityList property)</a>
|
||||
</li>
|
||||
@@ -1602,7 +1758,7 @@
|
||||
ngrok.services
|
||||
|
||||
<ul>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="certificate_authorities.html#module-ngrok.services">[3]</a>, <a href="credentials.html#module-ngrok.services">[4]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[5]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[6]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[15]</a>, <a href="edges_https.html#module-ngrok.services">[16]</a>, <a href="edges_https_routes.html#module-ngrok.services">[17]</a>, <a href="edges_tcp.html#module-ngrok.services">[18]</a>, <a href="edges_tls.html#module-ngrok.services">[19]</a>, <a href="endpoints.html#module-ngrok.services">[20]</a>, <a href="event_destinations.html#module-ngrok.services">[21]</a>, <a href="event_sources.html#module-ngrok.services">[22]</a>, <a href="event_subscriptions.html#module-ngrok.services">[23]</a>, <a href="failover_backends.html#module-ngrok.services">[24]</a>, <a href="http_response_backends.html#module-ngrok.services">[25]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[26]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[27]</a>, <a href="ip_policies.html#module-ngrok.services">[28]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[29]</a>, <a href="ip_restrictions.html#module-ngrok.services">[30]</a>, <a href="reserved_addrs.html#module-ngrok.services">[31]</a>, <a href="reserved_domains.html#module-ngrok.services">[32]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[33]</a>, <a href="ssh_credentials.html#module-ngrok.services">[34]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[35]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[36]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[37]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[38]</a>, <a href="tls_certificates.html#module-ngrok.services">[39]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[40]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[41]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[43]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[44]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[45]</a>, <a href="tunnels.html#module-ngrok.services">[46]</a>, <a href="weighted_backends.html#module-ngrok.services">[47]</a>
|
||||
<li><a href="abuse_reports.html#module-ngrok.services">module</a>, <a href="agent_ingresses.html#module-ngrok.services">[1]</a>, <a href="api_keys.html#module-ngrok.services">[2]</a>, <a href="application_sessions.html#module-ngrok.services">[3]</a>, <a href="application_users.html#module-ngrok.services">[4]</a>, <a href="certificate_authorities.html#module-ngrok.services">[5]</a>, <a href="credentials.html#module-ngrok.services">[6]</a>, <a href="edge_route_backend_module.html#module-ngrok.services">[7]</a>, <a href="edge_route_circuit_breaker_module.html#module-ngrok.services">[8]</a>, <a href="edge_route_compression_module.html#module-ngrok.services">[9]</a>, <a href="edge_route_ip_restriction_module.html#module-ngrok.services">[10]</a>, <a href="edge_route_o_auth_module.html#module-ngrok.services">[11]</a>, <a href="edge_route_oidc_module.html#module-ngrok.services">[12]</a>, <a href="edge_route_request_headers_module.html#module-ngrok.services">[13]</a>, <a href="edge_route_response_headers_module.html#module-ngrok.services">[14]</a>, <a href="edge_route_saml_module.html#module-ngrok.services">[15]</a>, <a href="edge_route_webhook_verification_module.html#module-ngrok.services">[16]</a>, <a href="edge_route_websocket_tcp_converter_module.html#module-ngrok.services">[17]</a>, <a href="edges_https.html#module-ngrok.services">[18]</a>, <a href="edges_https_routes.html#module-ngrok.services">[19]</a>, <a href="edges_tcp.html#module-ngrok.services">[20]</a>, <a href="edges_tls.html#module-ngrok.services">[21]</a>, <a href="endpoints.html#module-ngrok.services">[22]</a>, <a href="event_destinations.html#module-ngrok.services">[23]</a>, <a href="event_sources.html#module-ngrok.services">[24]</a>, <a href="event_subscriptions.html#module-ngrok.services">[25]</a>, <a href="failover_backends.html#module-ngrok.services">[26]</a>, <a href="http_response_backends.html#module-ngrok.services">[27]</a>, <a href="https_edge_mutual_tls_module.html#module-ngrok.services">[28]</a>, <a href="https_edge_tls_termination_module.html#module-ngrok.services">[29]</a>, <a href="ip_policies.html#module-ngrok.services">[30]</a>, <a href="ip_policy_rules.html#module-ngrok.services">[31]</a>, <a href="ip_restrictions.html#module-ngrok.services">[32]</a>, <a href="reserved_addrs.html#module-ngrok.services">[33]</a>, <a href="reserved_domains.html#module-ngrok.services">[34]</a>, <a href="ssh_certificate_authorities.html#module-ngrok.services">[35]</a>, <a href="ssh_credentials.html#module-ngrok.services">[36]</a>, <a href="ssh_host_certificates.html#module-ngrok.services">[37]</a>, <a href="ssh_user_certificates.html#module-ngrok.services">[38]</a>, <a href="tcp_edge_backend_module.html#module-ngrok.services">[39]</a>, <a href="tcp_edge_ip_restriction_module.html#module-ngrok.services">[40]</a>, <a href="tls_certificates.html#module-ngrok.services">[41]</a>, <a href="tls_edge_backend_module.html#module-ngrok.services">[42]</a>, <a href="tls_edge_ip_restriction_module.html#module-ngrok.services">[43]</a>, <a href="tls_edge_mutual_tls_module.html#module-ngrok.services">[44]</a>, <a href="tls_edge_tls_termination_module.html#module-ngrok.services">[45]</a>, <a href="tunnel_group_backends.html#module-ngrok.services">[46]</a>, <a href="tunnel_sessions.html#module-ngrok.services">[47]</a>, <a href="tunnels.html#module-ngrok.services">[48]</a>, <a href="weighted_backends.html#module-ngrok.services">[49]</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.not_after">not_after() (ngrok.datatypes.CertificateAuthority property)</a>
|
||||
@@ -1653,6 +1809,18 @@
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSession.os">os() (ngrok.datatypes.TunnelSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.os_name">os_name() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.os_version">os_version() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.owner_id">owner_id() (ngrok.datatypes.APIKey property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Credential.owner_id">(ngrok.datatypes.Credential property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredential.owner_id">(ngrok.datatypes.SSHCredential property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
</section>
|
||||
@@ -1687,6 +1855,8 @@
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.provider_user_id">provider_user_id() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ReservedDomainCertStatus.provisioning_job">provisioning_job() (ngrok.datatypes.ReservedDomainCertStatus property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority.public_key">public_key() (ngrok.datatypes.SSHCertificateAuthority property)</a>
|
||||
@@ -1699,9 +1869,11 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHUserCertificate.public_key">(ngrok.datatypes.SSHUserCertificate property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.public_url">public_url() (ngrok.datatypes.Endpoint property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.public_url">public_url() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.public_url">(ngrok.datatypes.Endpoint property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.public_url">(ngrok.datatypes.Tunnel property)</a>
|
||||
</li>
|
||||
</ul></li>
|
||||
@@ -1713,6 +1885,8 @@
|
||||
<h2>R</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent.raw">raw() (ngrok.datatypes.UserAgent property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Ref">Ref (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.region">region() (ngrok.datatypes.Endpoint property)</a>
|
||||
@@ -1824,6 +1998,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AWSRole.role_arn">role_arn() (ngrok.datatypes.AWSRole property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointCircuitBreaker.rolling_window">rolling_window() (ngrok.datatypes.EndpointCircuitBreaker property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.route">route() (ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdge.routes">routes() (ngrok.datatypes.HTTPSEdge property)</a>
|
||||
</li>
|
||||
@@ -1837,14 +2013,22 @@
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.saml">saml() (ngrok.datatypes.HTTPSEdgeRoute property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.scopes">scopes() (ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.scopes">scopes() (ngrok.datatypes.EndpointOAuthAmazon property)</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthFacebook.scopes">(ngrok.datatypes.EndpointOAuthFacebook property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitHub.scopes">(ngrok.datatypes.EndpointOAuthGitHub property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGitLab.scopes">(ngrok.datatypes.EndpointOAuthGitLab property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthGoogle.scopes">(ngrok.datatypes.EndpointOAuthGoogle property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthLinkedIn.scopes">(ngrok.datatypes.EndpointOAuthLinkedIn property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthMicrosoft.scopes">(ngrok.datatypes.EndpointOAuthMicrosoft property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthTwitch.scopes">(ngrok.datatypes.EndpointOAuthTwitch property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOIDC.scopes">(ngrok.datatypes.EndpointOIDC property)</a>
|
||||
</li>
|
||||
@@ -1893,12 +2077,12 @@
|
||||
</ul></li>
|
||||
<li><a href="ssh_certificate_authorities.html#ngrok.services.SSHCertificateAuthoritiesClient">SSHCertificateAuthoritiesClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthority">SSHCertificateAuthority (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCertificateAuthorityList">SSHCertificateAuthorityList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredential">SSHCredential (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.SSHCredentialList">SSHCredentialList (class in ngrok.datatypes)</a>
|
||||
@@ -2062,6 +2246,8 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.TunnelSessionList">TunnelSessionList (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="tunnel_sessions.html#ngrok.services.TunnelSessionsClient">TunnelSessionsClient (class in ngrok.services)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthProvider.twitch">twitch() (ngrok.datatypes.EndpointOAuthProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.type">type() (ngrok.datatypes.Endpoint property)</a>
|
||||
|
||||
@@ -2185,6 +2371,14 @@
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKey.uri">(ngrok.datatypes.APIKey property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.APIKeyList.uri">(ngrok.datatypes.APIKeyList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSession.uri">(ngrok.datatypes.ApplicationSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationSessionList.uri">(ngrok.datatypes.ApplicationSessionList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.uri">(ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUserList.uri">(ngrok.datatypes.ApplicationUserList property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.uri">(ngrok.datatypes.CertificateAuthority property)</a>
|
||||
</li>
|
||||
@@ -2289,7 +2483,15 @@
|
||||
</ul></li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.url">url() (ngrok.datatypes.IdentityProvider property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.AbuseReport.urls">urls() (ngrok.datatypes.AbuseReport property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession.user_agent">user_agent() (ngrok.datatypes.BrowserSession property)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.UserAgent">UserAgent (class in ngrok.datatypes)</a>
|
||||
</li>
|
||||
<li><a href="datatypes.html#ngrok.datatypes.ApplicationUser.username">username() (ngrok.datatypes.ApplicationUser property)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -292,6 +294,8 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
Binary file not shown.
@@ -117,6 +117,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -190,12 +192,13 @@ that you own by creating a CNAME record specified in the returned resource.
|
||||
This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.ReservedDomainsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_management_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ReservedDomainsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">certificate_management_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#ReservedDomainsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.ReservedDomainsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new reserved domain.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a ‘.’ it will reserve that subdomain on ngrok.io.</p></li>
|
||||
<li><p><strong>domain</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – hostname of the reserved domain</p></li>
|
||||
<li><p><strong>region</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of what this reserved domain will be used for</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p></li>
|
||||
|
||||
@@ -116,6 +116,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -188,15 +190,16 @@
|
||||
via the ngrok SSH tunnel gateway.</p>
|
||||
<dl class="py method">
|
||||
<dt id="ngrok.services.SSHCredentialsClient.create">
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">public_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">acl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">owner_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#SSHCredentialsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.SSHCredentialsClient.create" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the PEM-encoded public key of the SSH keypair that will be used to authenticate</p></li>
|
||||
<li><p><strong>owner_id</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
@@ -263,7 +266,7 @@ via the ngrok SSH tunnel gateway.</p>
|
||||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
<li><p><strong>acl</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]]) – optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule. The <code class="docutils literal notranslate"><span class="pre">bind</span></code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code class="docutils literal notranslate"><span class="pre">bind:example.ngrok.io</span></code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*.example.com</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">y.example.com</span></code>, <code class="docutils literal notranslate"><span class="pre">*.example.com</span></code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code class="docutils literal notranslate"><span class="pre">bind:*=example</span></code> which will allow <code class="docutils literal notranslate"><span class="pre">x=example</span></code>, <code class="docutils literal notranslate"><span class="pre">y=example</span></code>, etc. A rule of <code class="docutils literal notranslate"><span class="pre">'*'</span></code> is equivalent to no acl at all and will explicitly permit all actions.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -197,8 +199,9 @@ Certificate Authority used to sign the certificate.</p>
|
||||
<li><p><strong>ssh_certificate_authority_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the ssh certificate authority that is used to sign this ssh user certificate</p></li>
|
||||
<li><p><strong>public_key</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a public key in OpenSSH Authorized Keys format that this certificate signs</p></li>
|
||||
<li><p><strong>principals</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</p></li>
|
||||
<li><p><strong>critical_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code class="docutils literal notranslate"><span class="pre">force-command</span></code> and <code class="docutils literal notranslate"><span class="pre">source-address</span></code>. See <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></li>
|
||||
<li><p><strong>extensions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – 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></li>
|
||||
<li><p><strong>critical_options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code class="docutils literal notranslate"><span class="pre">force-command</span></code> and <code class="docutils literal notranslate"><span class="pre">source-address</span></code>. See <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p></li>
|
||||
<li><p><strong>extensions</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Mapping</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – <p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code class="docutils literal notranslate"><span class="pre">{"permit-pty":</span> <span class="pre">"",</span> <span class="pre">"permit-user-rc":</span> <span class="pre">""}</span></code> OpenSSH understands a number of predefined extensions. See <a class="reference external" href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
|
||||
</p></li>
|
||||
<li><p><strong>valid_after</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</p></li>
|
||||
<li><p><strong>valid_until</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code class="docutils literal notranslate"><span class="pre">valid_before</span></code>.</p></li>
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this SSH User Certificate. optional, max 255 bytes.</p></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
@@ -198,8 +200,8 @@ automated certificate provisioning.</p>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – human-readable description of this TLS certificate. optional, max 255 bytes.</p></li>
|
||||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.</p></li>
|
||||
<li><p><strong>certificate_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – 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></li>
|
||||
<li><p><strong>private_key_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – private key for the TLS certificate, PEM-encoded. See <cite>Private Keys</cite> <<a class="reference external" href="https://ngrok.com/docs/ngrok-link#tls-certificates-key">https://ngrok.com/docs/ngrok-link#tls-certificates-key</a>>`_.</p></li>
|
||||
<li><p><strong>certificate_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – chain of PEM-encoded certificates, leaf first. See <a class="reference external" href="https://ngrok.com/docs/api#tls-certificates-pem">Certificate Bundles</a>.</p></li>
|
||||
<li><p><strong>private_key_pem</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – private key for the TLS certificate, PEM-encoded. See <a class="reference external" href="https://ngrok.com/docs/ngrok-link#tls-certificates-key">Private Keys</a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
@@ -118,6 +118,8 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="abuse_reports.html">Abuse Reports</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="agent_ingresses.html">Agent Ingresses</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api_keys.html">API Keys</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_sessions.html">Application Sessions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="application_users.html">Application Users</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="failover_backends.html">Failover Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="http_response_backends.html">HTTP Response Backends</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="tunnel_group_backends.html">Tunnel Group Backends</a></li>
|
||||
|
||||
+10
-2
@@ -21,12 +21,20 @@ class Client(object):
|
||||
@property
|
||||
def api_keys(self) -> APIKeysClient:
|
||||
"""API Keys are used to authenticate to the `ngrok
|
||||
API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
API <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
to provision and manage API Keys but you'll need to provision your first API
|
||||
key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
key from the `API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
ngrok.com dashboard."""
|
||||
return APIKeysClient(self)
|
||||
|
||||
@property
|
||||
def application_sessions(self) -> ApplicationSessionsClient:
|
||||
return ApplicationSessionsClient(self)
|
||||
|
||||
@property
|
||||
def application_users(self) -> ApplicationUsersClient:
|
||||
return ApplicationUsersClient(self)
|
||||
|
||||
@property
|
||||
def certificate_authorities(self) -> CertificateAuthoritiesClient:
|
||||
"""Certificate Authorities are x509 certificates that are used to sign other
|
||||
|
||||
+609
-17
@@ -1,5 +1,6 @@
|
||||
from __future__ import annotations
|
||||
from typing import Any, Mapping, Sequence
|
||||
from datetime import datetime, timedelta
|
||||
from .iterator import PagedIterator
|
||||
|
||||
|
||||
@@ -281,6 +282,11 @@ class APIKey(object):
|
||||
"""the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. **This value is only available one time, on the API response from key creation. Otherwise it is null.**"""
|
||||
return self._props["token"]
|
||||
|
||||
@property
|
||||
def owner_id(self) -> str:
|
||||
"""If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot."""
|
||||
return self._props["owner_id"]
|
||||
|
||||
|
||||
class APIKeyList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -320,6 +326,402 @@ class APIKeyList(object):
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class ApplicationSession(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["browser_session"] = (
|
||||
BrowserSession(client, props["browser_session"])
|
||||
if props.get("browser_session") is not None
|
||||
else None
|
||||
)
|
||||
self._props["application_user"] = (
|
||||
Ref(client, props["application_user"])
|
||||
if props.get("application_user") is not None
|
||||
else None
|
||||
)
|
||||
self._props["endpoint"] = (
|
||||
Ref(client, props["endpoint"])
|
||||
if props.get("endpoint") is not None
|
||||
else None
|
||||
)
|
||||
self._props["edge"] = (
|
||||
Ref(client, props["edge"]) if props.get("edge") is not None else None
|
||||
)
|
||||
self._props["route"] = (
|
||||
Ref(client, props["route"]) if props.get("route") is not None else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ApplicationSession {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ApplicationSession {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.application_sessions.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""unique application session resource identifier"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the application session API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def public_url(self) -> str:
|
||||
"""URL of the hostport served by this endpoint"""
|
||||
return self._props["public_url"]
|
||||
|
||||
@property
|
||||
def browser_session(self) -> BrowserSession:
|
||||
"""browser session details of the application session"""
|
||||
return self._props["browser_session"]
|
||||
|
||||
@property
|
||||
def application_user(self) -> Ref:
|
||||
"""application user this session is associated with"""
|
||||
return self._props["application_user"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> str:
|
||||
"""timestamp when the user was created in RFC 3339 format"""
|
||||
return self._props["created_at"]
|
||||
|
||||
@property
|
||||
def last_active(self) -> str:
|
||||
"""timestamp when the user was last active in RFC 3339 format"""
|
||||
return self._props["last_active"]
|
||||
|
||||
@property
|
||||
def expires_at(self) -> str:
|
||||
"""timestamp when session expires in RFC 3339 format"""
|
||||
return self._props["expires_at"]
|
||||
|
||||
@property
|
||||
def endpoint(self) -> Ref:
|
||||
"""ephemeral endpoint this session is associated with"""
|
||||
return self._props["endpoint"]
|
||||
|
||||
@property
|
||||
def edge(self) -> Ref:
|
||||
"""edge this session is associated with, null if the endpoint is agent-initiated"""
|
||||
return self._props["edge"]
|
||||
|
||||
@property
|
||||
def route(self) -> Ref:
|
||||
"""route this session is associated with, null if the endpoint is agent-initiated"""
|
||||
return self._props["route"]
|
||||
|
||||
|
||||
class ApplicationSessionList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["application_sessions"] = (
|
||||
[ApplicationSession(client, x) for x in props["application_sessions"]]
|
||||
if props.get("application_sessions") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ApplicationSessionList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ApplicationSessionList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "application_sessions")
|
||||
|
||||
@property
|
||||
def application_sessions(self) -> Sequence[ApplicationSession]:
|
||||
"""list of all application sessions on this account"""
|
||||
return self._props["application_sessions"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the application session list API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class BrowserSession(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["user_agent"] = (
|
||||
UserAgent(client, props["user_agent"])
|
||||
if props.get("user_agent") is not None
|
||||
else None
|
||||
)
|
||||
self._props["location"] = (
|
||||
Location(client, props["location"])
|
||||
if props.get("location") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<BrowserSession {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<BrowserSession {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def user_agent(self) -> UserAgent:
|
||||
"""HTTP User-Agent data"""
|
||||
return self._props["user_agent"]
|
||||
|
||||
@property
|
||||
def ip_address(self) -> str:
|
||||
"""IP address"""
|
||||
return self._props["ip_address"]
|
||||
|
||||
@property
|
||||
def location(self) -> Location:
|
||||
"""IP geolocation data"""
|
||||
return self._props["location"]
|
||||
|
||||
|
||||
class UserAgent(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<UserAgent {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<UserAgent {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def raw(self) -> str:
|
||||
"""raw User-Agent request header"""
|
||||
return self._props["raw"]
|
||||
|
||||
@property
|
||||
def browser_name(self) -> str:
|
||||
"""browser name (e.g. Chrome)"""
|
||||
return self._props["browser_name"]
|
||||
|
||||
@property
|
||||
def browser_version(self) -> str:
|
||||
"""browser version (e.g. 102)"""
|
||||
return self._props["browser_version"]
|
||||
|
||||
@property
|
||||
def device_type(self) -> str:
|
||||
"""type of device (e.g. Desktop)"""
|
||||
return self._props["device_type"]
|
||||
|
||||
@property
|
||||
def os_name(self) -> str:
|
||||
"""operating system name (e.g. MacOS)"""
|
||||
return self._props["os_name"]
|
||||
|
||||
@property
|
||||
def os_version(self) -> str:
|
||||
"""operating system version (e.g. 10.15.7)"""
|
||||
return self._props["os_version"]
|
||||
|
||||
|
||||
class Location(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<Location {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<Location {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def country_code(self) -> str:
|
||||
"""ISO country code"""
|
||||
return self._props["country_code"]
|
||||
|
||||
@property
|
||||
def latitude(self) -> float:
|
||||
"""geographical latitude"""
|
||||
return self._props["latitude"]
|
||||
|
||||
@property
|
||||
def longitude(self) -> float:
|
||||
"""geographical longitude"""
|
||||
return self._props["longitude"]
|
||||
|
||||
@property
|
||||
def lat_long_radius_km(self) -> int:
|
||||
"""accuracy radius of the geographical coordinates"""
|
||||
return self._props["lat_long_radius_km"]
|
||||
|
||||
|
||||
class ApplicationUser(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["identity_provider"] = (
|
||||
IdentityProvider(client, props["identity_provider"])
|
||||
if props.get("identity_provider") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ApplicationUser {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ApplicationUser {}>".format(repr(self._props))
|
||||
|
||||
def delete(
|
||||
self,
|
||||
):
|
||||
self._client.application_users.delete(
|
||||
id=self.id,
|
||||
)
|
||||
|
||||
@property
|
||||
def id(self) -> str:
|
||||
"""unique application user resource identifier"""
|
||||
return self._props["id"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the application user API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def identity_provider(self) -> IdentityProvider:
|
||||
"""identity provider that the user authenticated with"""
|
||||
return self._props["identity_provider"]
|
||||
|
||||
@property
|
||||
def provider_user_id(self) -> str:
|
||||
"""unique user identifier"""
|
||||
return self._props["provider_user_id"]
|
||||
|
||||
@property
|
||||
def username(self) -> str:
|
||||
"""user username"""
|
||||
return self._props["username"]
|
||||
|
||||
@property
|
||||
def email(self) -> str:
|
||||
"""user email"""
|
||||
return self._props["email"]
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""user common name"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def created_at(self) -> str:
|
||||
"""timestamp when the user was created in RFC 3339 format"""
|
||||
return self._props["created_at"]
|
||||
|
||||
@property
|
||||
def last_active(self) -> str:
|
||||
"""timestamp when the user was last active in RFC 3339 format"""
|
||||
return self._props["last_active"]
|
||||
|
||||
@property
|
||||
def last_login(self) -> str:
|
||||
"""timestamp when the user last signed-in in RFC 3339 format"""
|
||||
return self._props["last_login"]
|
||||
|
||||
|
||||
class ApplicationUserList(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
self._props["application_users"] = (
|
||||
[ApplicationUser(client, x) for x in props["application_users"]]
|
||||
if props.get("application_users") is not None
|
||||
else []
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<ApplicationUserList {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<ApplicationUserList {}>".format(repr(self._props))
|
||||
|
||||
def __iter__(self):
|
||||
return PagedIterator(self._client, self, "application_users")
|
||||
|
||||
@property
|
||||
def application_users(self) -> Sequence[ApplicationUser]:
|
||||
"""list of all application users on this account"""
|
||||
return self._props["application_users"]
|
||||
|
||||
@property
|
||||
def uri(self) -> str:
|
||||
"""URI of the application user list API resource"""
|
||||
return self._props["uri"]
|
||||
|
||||
@property
|
||||
def next_page_uri(self) -> str:
|
||||
"""URI of the next page, or null if there is no next page"""
|
||||
return self._props["next_page_uri"]
|
||||
|
||||
|
||||
class IdentityProvider(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<IdentityProvider {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<IdentityProvider {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def name(self) -> str:
|
||||
"""name of the identity provider (e.g. Google)"""
|
||||
return self._props["name"]
|
||||
|
||||
@property
|
||||
def url(self) -> str:
|
||||
"""URL of the identity provider (e.g. `https://accounts.google.com <https://accounts.google.com>`_)"""
|
||||
return self._props["url"]
|
||||
|
||||
|
||||
class FailoverBackend(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -944,9 +1346,14 @@ class Credential(object):
|
||||
|
||||
@property
|
||||
def acl(self) -> Sequence[str]:
|
||||
"""optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
|
||||
"""optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
|
||||
return self._props["acl"]
|
||||
|
||||
@property
|
||||
def owner_id(self) -> str:
|
||||
"""If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot."""
|
||||
return self._props["owner_id"]
|
||||
|
||||
|
||||
class CredentialList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -1009,7 +1416,7 @@ class EndpointWebhookValidation(object):
|
||||
|
||||
@property
|
||||
def provider(self) -> str:
|
||||
"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: ``SLACK``, ``SNS``, ``STRIPE``, ``GITHUB``, ``TWILIO``, ``SHOPIFY``, ``GITLAB``, ``INTERCOM``, ``SENDGRID``, ``XERO``, ``PAGERDUTY``."""
|
||||
"""a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at `https://ngrok.com/docs/cloud-edge/modules/webhook <https://ngrok.com/docs/cloud-edge/modules/webhook>`_"""
|
||||
return self._props["provider"]
|
||||
|
||||
@property
|
||||
@@ -1284,9 +1691,9 @@ class EndpointCircuitBreaker(object):
|
||||
return self._props["enabled"]
|
||||
|
||||
@property
|
||||
def tripped_duration(self) -> int:
|
||||
def tripped_duration(self) -> timedelta:
|
||||
"""Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health"""
|
||||
return self._props["tripped_duration"]
|
||||
return timedelta(seconds=self._props["tripped_duration"])
|
||||
|
||||
@property
|
||||
def rolling_window(self) -> int:
|
||||
@@ -1354,9 +1761,9 @@ class EndpointOAuth(object):
|
||||
return self._props["inactivity_timeout"]
|
||||
|
||||
@property
|
||||
def maximum_duration(self) -> int:
|
||||
def maximum_duration(self) -> timedelta:
|
||||
"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
|
||||
return self._props["maximum_duration"]
|
||||
return timedelta(seconds=self._props["maximum_duration"])
|
||||
|
||||
@property
|
||||
def auth_check_interval(self) -> int:
|
||||
@@ -1388,6 +1795,26 @@ class EndpointOAuthProvider(object):
|
||||
if props.get("google") is not None
|
||||
else None
|
||||
)
|
||||
self._props["linkedin"] = (
|
||||
EndpointOAuthLinkedIn(client, props["linkedin"])
|
||||
if props.get("linkedin") is not None
|
||||
else None
|
||||
)
|
||||
self._props["gitlab"] = (
|
||||
EndpointOAuthGitLab(client, props["gitlab"])
|
||||
if props.get("gitlab") is not None
|
||||
else None
|
||||
)
|
||||
self._props["twitch"] = (
|
||||
EndpointOAuthTwitch(client, props["twitch"])
|
||||
if props.get("twitch") is not None
|
||||
else None
|
||||
)
|
||||
self._props["amazon"] = (
|
||||
EndpointOAuthAmazon(client, props["amazon"])
|
||||
if props.get("amazon") is not None
|
||||
else None
|
||||
)
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
@@ -1418,6 +1845,26 @@ class EndpointOAuthProvider(object):
|
||||
"""configuration for using google as the identity provider"""
|
||||
return self._props["google"]
|
||||
|
||||
@property
|
||||
def linkedin(self) -> EndpointOAuthLinkedIn:
|
||||
"""configuration for using linkedin as the identity provider"""
|
||||
return self._props["linkedin"]
|
||||
|
||||
@property
|
||||
def gitlab(self) -> EndpointOAuthGitLab:
|
||||
"""configuration for using gitlab as the identity provider"""
|
||||
return self._props["gitlab"]
|
||||
|
||||
@property
|
||||
def twitch(self) -> EndpointOAuthTwitch:
|
||||
"""configuration for using twitch as the identity provider"""
|
||||
return self._props["twitch"]
|
||||
|
||||
@property
|
||||
def amazon(self) -> EndpointOAuthAmazon:
|
||||
"""configuration for using amazon as the identity provider"""
|
||||
return self._props["amazon"]
|
||||
|
||||
|
||||
class EndpointOAuthGitHub(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -1589,6 +2036,146 @@ class EndpointOAuthGoogle(object):
|
||||
return self._props["email_domains"]
|
||||
|
||||
|
||||
class EndpointOAuthLinkedIn(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointOAuthLinkedIn {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointOAuthLinkedIn {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def client_id(self) -> str:
|
||||
return self._props["client_id"]
|
||||
|
||||
@property
|
||||
def client_secret(self) -> str:
|
||||
return self._props["client_secret"]
|
||||
|
||||
@property
|
||||
def scopes(self) -> Sequence[str]:
|
||||
return self._props["scopes"]
|
||||
|
||||
@property
|
||||
def email_addresses(self) -> Sequence[str]:
|
||||
return self._props["email_addresses"]
|
||||
|
||||
@property
|
||||
def email_domains(self) -> Sequence[str]:
|
||||
return self._props["email_domains"]
|
||||
|
||||
|
||||
class EndpointOAuthGitLab(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointOAuthGitLab {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointOAuthGitLab {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def client_id(self) -> str:
|
||||
return self._props["client_id"]
|
||||
|
||||
@property
|
||||
def client_secret(self) -> str:
|
||||
return self._props["client_secret"]
|
||||
|
||||
@property
|
||||
def scopes(self) -> Sequence[str]:
|
||||
return self._props["scopes"]
|
||||
|
||||
@property
|
||||
def email_addresses(self) -> Sequence[str]:
|
||||
return self._props["email_addresses"]
|
||||
|
||||
@property
|
||||
def email_domains(self) -> Sequence[str]:
|
||||
return self._props["email_domains"]
|
||||
|
||||
|
||||
class EndpointOAuthTwitch(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointOAuthTwitch {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointOAuthTwitch {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def client_id(self) -> str:
|
||||
return self._props["client_id"]
|
||||
|
||||
@property
|
||||
def client_secret(self) -> str:
|
||||
return self._props["client_secret"]
|
||||
|
||||
@property
|
||||
def scopes(self) -> Sequence[str]:
|
||||
return self._props["scopes"]
|
||||
|
||||
@property
|
||||
def email_addresses(self) -> Sequence[str]:
|
||||
return self._props["email_addresses"]
|
||||
|
||||
@property
|
||||
def email_domains(self) -> Sequence[str]:
|
||||
return self._props["email_domains"]
|
||||
|
||||
|
||||
class EndpointOAuthAmazon(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
self._props = props
|
||||
|
||||
def __eq__(self, other):
|
||||
return self._props == other._props
|
||||
|
||||
def __str__(self):
|
||||
if "id" in self._props:
|
||||
return "<EndpointOAuthAmazon {} {}>".format(self.id, repr(self._props))
|
||||
else:
|
||||
return "<EndpointOAuthAmazon {}>".format(repr(self._props))
|
||||
|
||||
@property
|
||||
def client_id(self) -> str:
|
||||
return self._props["client_id"]
|
||||
|
||||
@property
|
||||
def client_secret(self) -> str:
|
||||
return self._props["client_secret"]
|
||||
|
||||
@property
|
||||
def scopes(self) -> Sequence[str]:
|
||||
return self._props["scopes"]
|
||||
|
||||
@property
|
||||
def email_addresses(self) -> Sequence[str]:
|
||||
return self._props["email_addresses"]
|
||||
|
||||
@property
|
||||
def email_domains(self) -> Sequence[str]:
|
||||
return self._props["email_domains"]
|
||||
|
||||
|
||||
class EndpointSAML(object):
|
||||
def __init__(self, client, props):
|
||||
self._client = client
|
||||
@@ -1624,9 +2211,9 @@ class EndpointSAML(object):
|
||||
return self._props["inactivity_timeout"]
|
||||
|
||||
@property
|
||||
def maximum_duration(self) -> int:
|
||||
def maximum_duration(self) -> timedelta:
|
||||
"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
|
||||
return self._props["maximum_duration"]
|
||||
return timedelta(seconds=self._props["maximum_duration"])
|
||||
|
||||
@property
|
||||
def idp_metadata(self) -> str:
|
||||
@@ -1714,9 +2301,9 @@ class EndpointSAMLMutate(object):
|
||||
return self._props["inactivity_timeout"]
|
||||
|
||||
@property
|
||||
def maximum_duration(self) -> int:
|
||||
def maximum_duration(self) -> timedelta:
|
||||
"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
|
||||
return self._props["maximum_duration"]
|
||||
return timedelta(seconds=self._props["maximum_duration"])
|
||||
|
||||
@property
|
||||
def idp_metadata(self) -> str:
|
||||
@@ -1779,9 +2366,9 @@ class EndpointOIDC(object):
|
||||
return self._props["inactivity_timeout"]
|
||||
|
||||
@property
|
||||
def maximum_duration(self) -> int:
|
||||
def maximum_duration(self) -> timedelta:
|
||||
"""Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate."""
|
||||
return self._props["maximum_duration"]
|
||||
return timedelta(seconds=self._props["maximum_duration"])
|
||||
|
||||
@property
|
||||
def issuer(self) -> str:
|
||||
@@ -3937,9 +4524,14 @@ class SSHCredential(object):
|
||||
|
||||
@property
|
||||
def acl(self) -> Sequence[str]:
|
||||
"""optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
|
||||
"""optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions."""
|
||||
return self._props["acl"]
|
||||
|
||||
@property
|
||||
def owner_id(self) -> str:
|
||||
"""If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot."""
|
||||
return self._props["owner_id"]
|
||||
|
||||
|
||||
class SSHCredentialList(object):
|
||||
def __init__(self, client, props):
|
||||
@@ -4189,12 +4781,12 @@ class SSHUserCertificate(object):
|
||||
|
||||
@property
|
||||
def critical_options(self) -> Mapping[str, str]:
|
||||
"""A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
|
||||
"""A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
|
||||
return self._props["critical_options"]
|
||||
|
||||
@property
|
||||
def extensions(self) -> Mapping[str, str]:
|
||||
"""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: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
|
||||
"""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: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details."""
|
||||
return self._props["extensions"]
|
||||
|
||||
@property
|
||||
@@ -4315,7 +4907,7 @@ class TLSCertificate(object):
|
||||
|
||||
@property
|
||||
def certificate_pem(self) -> str:
|
||||
"""chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_."""
|
||||
"""chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/api#tls-certificates-pem>`_."""
|
||||
return self._props["certificate_pem"]
|
||||
|
||||
@property
|
||||
@@ -4611,7 +5203,7 @@ class Tunnel(object):
|
||||
|
||||
@property
|
||||
def metadata(self) -> str:
|
||||
"""user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option` <https://ngrok.com/docs#tunnel-definitions-metadata>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option` <https://ngrok.com/docs#config_metadata>`_."""
|
||||
"""user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel `metadata configuration option <https://ngrok.com/docs#tunnel-definitions-metadata>`_ In API version 0, this value was instead pulled from the top-level `metadata configuration option <https://ngrok.com/docs#config_metadata>`_."""
|
||||
return self._props["metadata"]
|
||||
|
||||
@property
|
||||
|
||||
+145
-12
@@ -1,6 +1,7 @@
|
||||
from __future__ import annotations
|
||||
from collections.abc import Iterator
|
||||
from typing import Any, Mapping, Sequence
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
from .http_client import HTTPClient
|
||||
from .datatypes import *
|
||||
@@ -163,9 +164,9 @@ class AgentIngressesClient(object):
|
||||
|
||||
class APIKeysClient(object):
|
||||
"""API Keys are used to authenticate to the `ngrok
|
||||
API` <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
API <https://ngrok.com/docs/api#authentication>`_. You may use the API itself
|
||||
to provision and manage API Keys but you'll need to provision your first API
|
||||
key from the `API Keys page` <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
key from the `API Keys page <https://dashboard.ngrok.com/api/keys>`_ on your
|
||||
ngrok.com dashboard."""
|
||||
|
||||
def __init__(self, client):
|
||||
@@ -175,11 +176,13 @@ class APIKeysClient(object):
|
||||
self,
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
owner_id: str = None,
|
||||
) -> APIKey:
|
||||
"""Create a new API key. The generated API key can be used to authenticate to the ngrok API.
|
||||
|
||||
:param description: human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined data of this API key. optional, max 4096 bytes
|
||||
:param owner_id: If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
||||
|
||||
https://ngrok.com/docs/api#api-api-keys-create
|
||||
"""
|
||||
@@ -187,6 +190,7 @@ class APIKeysClient(object):
|
||||
body_arg = dict(
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
owner_id=owner_id,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return APIKey(self._client, result)
|
||||
@@ -272,6 +276,126 @@ class APIKeysClient(object):
|
||||
return APIKey(self._client, result)
|
||||
|
||||
|
||||
class ApplicationSessionsClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> ApplicationSession:
|
||||
"""Get an application session by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-application-sessions-get
|
||||
"""
|
||||
path = "/app/sessions/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ApplicationSession(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete an application session by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-application-sessions-delete
|
||||
"""
|
||||
path = "/app/sessions/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> ApplicationSessionList:
|
||||
"""List all application sessions for this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-application-sessions-list
|
||||
"""
|
||||
path = "/app/sessions"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ApplicationSessionList(self._client, result)
|
||||
|
||||
|
||||
class ApplicationUsersClient(object):
|
||||
def __init__(self, client):
|
||||
self._client = client
|
||||
|
||||
def get(
|
||||
self,
|
||||
id: str,
|
||||
) -> ApplicationUser:
|
||||
"""Get an application user by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-application-users-get
|
||||
"""
|
||||
path = "/app/users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ApplicationUser(self._client, result)
|
||||
|
||||
def delete(
|
||||
self,
|
||||
id: str,
|
||||
):
|
||||
"""Delete an application user by ID.
|
||||
|
||||
:param id: a resource identifier
|
||||
|
||||
https://ngrok.com/docs/api#api-application-users-delete
|
||||
"""
|
||||
path = "/app/users/{id}"
|
||||
path = path.format(
|
||||
id=id,
|
||||
)
|
||||
body_arg = None
|
||||
self._client.http_client.delete(path, body_arg)
|
||||
|
||||
def list(
|
||||
self,
|
||||
before_id: str = None,
|
||||
limit: str = None,
|
||||
) -> ApplicationUserList:
|
||||
"""List all application users for this account.
|
||||
|
||||
:param before_id:
|
||||
:param limit:
|
||||
|
||||
https://ngrok.com/docs/api#api-application-users-list
|
||||
"""
|
||||
path = "/app/users"
|
||||
body_arg = dict(
|
||||
before_id=before_id,
|
||||
limit=limit,
|
||||
)
|
||||
result = self._client.http_client.get(path, body_arg)
|
||||
return ApplicationUserList(self._client, result)
|
||||
|
||||
|
||||
class FailoverBackendsClient(object):
|
||||
"""A Failover backend defines failover behavior within a list of referenced
|
||||
backends. Traffic is sent to the first backend in the list. If that backend
|
||||
@@ -869,12 +993,14 @@ class CredentialsClient(object):
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
acl: Sequence[str] = [],
|
||||
owner_id: str = None,
|
||||
) -> Credential:
|
||||
"""Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.
|
||||
|
||||
:param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param owner_id: If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
||||
|
||||
https://ngrok.com/docs/api#api-credentials-create
|
||||
"""
|
||||
@@ -883,6 +1009,7 @@ class CredentialsClient(object):
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
acl=acl,
|
||||
owner_id=owner_id,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return Credential(self._client, result)
|
||||
@@ -954,7 +1081,7 @@ class CredentialsClient(object):
|
||||
:param id:
|
||||
:param description: human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
|
||||
https://ngrok.com/docs/api#api-credentials-update
|
||||
"""
|
||||
@@ -2826,7 +2953,7 @@ class EventDestinationsClient(object):
|
||||
format: str = "",
|
||||
target: EventTarget = None,
|
||||
) -> EventDestination:
|
||||
"""Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.
|
||||
"""Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.
|
||||
|
||||
:param metadata: Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
|
||||
:param description: Human-readable description of the Event Destination. Optional, max 255 bytes.
|
||||
@@ -3636,7 +3763,8 @@ class ReservedDomainsClient(object):
|
||||
|
||||
def create(
|
||||
self,
|
||||
name: str,
|
||||
name: str = "",
|
||||
domain: str = "",
|
||||
region: str = "",
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
@@ -3646,6 +3774,7 @@ class ReservedDomainsClient(object):
|
||||
"""Create a new reserved domain.
|
||||
|
||||
:param name: the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
|
||||
:param domain: hostname of the reserved domain
|
||||
:param region: reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
|
||||
:param description: human-readable description of what this reserved domain will be used for
|
||||
:param metadata: arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
|
||||
@@ -3657,6 +3786,7 @@ class ReservedDomainsClient(object):
|
||||
path = "/reserved_domains"
|
||||
body_arg = dict(
|
||||
name=name,
|
||||
domain=domain,
|
||||
region=region,
|
||||
description=description,
|
||||
metadata=metadata,
|
||||
@@ -3917,13 +4047,15 @@ class SSHCredentialsClient(object):
|
||||
description: str = "",
|
||||
metadata: str = "",
|
||||
acl: Sequence[str] = [],
|
||||
owner_id: str = None,
|
||||
) -> SSHCredential:
|
||||
"""Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.
|
||||
|
||||
:param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param public_key: the PEM-encoded public key of the SSH keypair that will be used to authenticate
|
||||
:param owner_id: If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.
|
||||
|
||||
https://ngrok.com/docs/api#api-ssh-credentials-create
|
||||
"""
|
||||
@@ -3933,6 +4065,7 @@ class SSHCredentialsClient(object):
|
||||
metadata=metadata,
|
||||
acl=acl,
|
||||
public_key=public_key,
|
||||
owner_id=owner_id,
|
||||
)
|
||||
result = self._client.http_client.post(path, body_arg)
|
||||
return SSHCredential(self._client, result)
|
||||
@@ -4004,7 +4137,7 @@ class SSHCredentialsClient(object):
|
||||
:param id:
|
||||
:param description: human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` 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 ``bind:example.ngrok.io``. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
:param acl: optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the ``bind`` rule. The ``bind`` rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule ``bind:example.ngrok.io``. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of ``bind:*.example.com`` which will allow ``x.example.com``, ``y.example.com``, ``*.example.com``, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of ``bind:*=example`` which will allow ``x=example``, ``y=example``, etc. A rule of ``'*'`` is equivalent to no acl at all and will explicitly permit all actions.
|
||||
|
||||
https://ngrok.com/docs/api#api-ssh-credentials-update
|
||||
"""
|
||||
@@ -4170,8 +4303,8 @@ class SSHUserCertificatesClient(object):
|
||||
:param ssh_certificate_authority_id: the ssh certificate authority that is used to sign this ssh user certificate
|
||||
:param public_key: a public key in OpenSSH Authorized Keys format that this certificate signs
|
||||
:param principals: the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
|
||||
:param critical_options: A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
|
||||
:param extensions: 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: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec` <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
|
||||
:param critical_options: A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: ``force-command`` and ``source-address``. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
|
||||
:param extensions: 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: ``{"permit-pty": "", "permit-user-rc": ""}`` OpenSSH understands a number of predefined extensions. See `the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>`_ for additional details.
|
||||
:param valid_after: The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
|
||||
:param valid_until: The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this ``valid_before``.
|
||||
:param description: human-readable description of this SSH User Certificate. optional, max 255 bytes.
|
||||
@@ -4296,8 +4429,8 @@ class TLSCertificatesClient(object):
|
||||
|
||||
:param description: human-readable description of this TLS certificate. optional, max 255 bytes.
|
||||
:param metadata: arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
|
||||
:param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles` <https://ngrok.com/docs/api#tls-certificates-pem>`_.
|
||||
:param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys` <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.
|
||||
:param certificate_pem: chain of PEM-encoded certificates, leaf first. See `Certificate Bundles <https://ngrok.com/docs/api#tls-certificates-pem>`_.
|
||||
:param private_key_pem: private key for the TLS certificate, PEM-encoded. See `Private Keys <https://ngrok.com/docs/ngrok-link#tls-certificates-key>`_.
|
||||
|
||||
https://ngrok.com/docs/api#api-tls-certificates-create
|
||||
"""
|
||||
|
||||
@@ -8,7 +8,7 @@ def read_file(filename):
|
||||
|
||||
setup(
|
||||
name="ngrok-api",
|
||||
version="0.9.0",
|
||||
version="0.10.0",
|
||||
description="ngrok HTTP API client library",
|
||||
long_description=read_file("README.md"),
|
||||
long_description_content_type="text/markdown",
|
||||
|
||||
+1
-1
@@ -79,7 +79,7 @@ def test_domains():
|
||||
c.reserved_domains.list()
|
||||
|
||||
mock.returns(mock_reserved_domain)
|
||||
domain = c.reserved_domains.create(name="foo")
|
||||
domain = c.reserved_domains.create(domain="foo.ngrok.io.lan")
|
||||
mock.returns(mock_reserved_domain)
|
||||
domain = c.reserved_domains.get(domain.id)
|
||||
assert domain.domain == "foo.ngrok.io.lan"
|
||||
|
||||
Reference in New Issue
Block a user