ngrok/ngrok-api-typescript
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-typescript.git synced 2026-05-17 16:50:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
ngrok-api-typescript/docs/interfaces/datatypes.SSHCredential.html
T
ngrok release bot b781552831 Update generated files
2026-01-23 21:37:49 +00:00

300 lines
14 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SSHCredential | @ngrok/ngrok-api</title>
<meta name="description" content="Documentation for @ngrok/ngrok-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@ngrok/ngrok-api</a>
</li>
<li>
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li>
<a href="datatypes.SSHCredential.html">SSHCredential</a>
</li>
</ul>
<h1>Interface SSHCredential</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SSHCredential</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#acl" class="tsd-kind-icon">acl</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#description" class="tsd-kind-icon">description</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#uri" class="tsd-kind-icon">uri</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="acl" class="tsd-anchor"></a>
<h3>acl</h3>
<div class="tsd-signature tsd-kind-icon">acl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2252">datatypes.ts:2252</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>bind</code> rule. The <code>bind</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>bind:example.ngrok.io</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>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</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>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="createdAt" class="tsd-anchor"></a>
<h3>created<wbr>At</h3>
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2244">datatypes.ts:2244</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>timestamp when the ssh credential was created, RFC 3339 format</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="description" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2246">datatypes.ts:2246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2240">datatypes.ts:2240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>unique ssh credential resource identifier</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="metadata" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2248">datatypes.ts:2248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ownerId" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2254">datatypes.ts:2254</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<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>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="publicKey" class="tsd-anchor"></a>
<h3>public<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2250">datatypes.ts:2250</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="uri" class="tsd-anchor"></a>
<h3>uri</h3>
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L2242">datatypes.ts:2242</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URI of the ssh credential API resource</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/client.html">client</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/services.html">services</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="datatypes.SSHCredential.html" class="tsd-kind-icon">SSHCredential</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#acl" class="tsd-kind-icon">acl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#description" class="tsd-kind-icon">description</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.SSHCredential.html#uri" class="tsd-kind-icon">uri</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink