@ngrok/ngrok-api 0.0.9 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (218) hide show
  1. package/.eslintrc.js +4 -1
  2. package/CHANGELOG.md +34 -0
  3. package/README.md +148 -2
  4. package/docs/CNAME +1 -0
  5. package/docs/assets/css/main.css +2660 -0
  6. package/docs/assets/images/icons.png +0 -0
  7. package/docs/assets/images/icons@2x.png +0 -0
  8. package/docs/assets/images/widgets.png +0 -0
  9. package/docs/assets/images/widgets@2x.png +0 -0
  10. package/docs/assets/js/main.js +248 -0
  11. package/docs/assets/js/search.js +1 -0
  12. package/docs/classes/client.Ngrok.html +681 -0
  13. package/docs/classes/services.APIKeys.html +453 -0
  14. package/docs/classes/services.AbuseReports.html +360 -0
  15. package/docs/classes/services.AgentIngresses.html +442 -0
  16. package/docs/classes/services.CertificateAuthorities.html +453 -0
  17. package/docs/classes/services.Credentials.html +452 -0
  18. package/docs/classes/services.EndpointCircuitBreakerModule.html +369 -0
  19. package/docs/classes/services.EndpointCompressionModule.html +369 -0
  20. package/docs/classes/services.EndpointConfigurations.html +451 -0
  21. package/docs/classes/services.EndpointIPPolicyModule.html +369 -0
  22. package/docs/classes/services.EndpointLoggingModule.html +369 -0
  23. package/docs/classes/services.EndpointMutualTLSModule.html +369 -0
  24. package/docs/classes/services.EndpointOAuthModule.html +369 -0
  25. package/docs/classes/services.EndpointOIDCModule.html +369 -0
  26. package/docs/classes/services.EndpointRequestHeadersModule.html +369 -0
  27. package/docs/classes/services.EndpointResponseHeadersModule.html +369 -0
  28. package/docs/classes/services.EndpointSAMLModule.html +369 -0
  29. package/docs/classes/services.EndpointTLSTerminationModule.html +369 -0
  30. package/docs/classes/services.EndpointWebhookValidationModule.html +369 -0
  31. package/docs/classes/services.EventDestinations.html +442 -0
  32. package/docs/classes/services.EventSources.html +448 -0
  33. package/docs/classes/services.EventStreams.html +442 -0
  34. package/docs/classes/services.EventSubscriptions.html +442 -0
  35. package/docs/classes/services.IPPolicies.html +452 -0
  36. package/docs/classes/services.IPPolicyRules.html +450 -0
  37. package/docs/classes/services.IPRestrictions.html +454 -0
  38. package/docs/classes/services.ReservedAddrs.html +483 -0
  39. package/docs/classes/services.ReservedDomains.html +580 -0
  40. package/docs/classes/services.SSHCertificateAuthorities.html +450 -0
  41. package/docs/classes/services.SSHCredentials.html +450 -0
  42. package/docs/classes/services.SSHHostCertificates.html +451 -0
  43. package/docs/classes/services.SSHUserCertificates.html +451 -0
  44. package/docs/classes/services.TLSCertificates.html +453 -0
  45. package/docs/classes/services.TunnelSessions.html +451 -0
  46. package/docs/classes/services.Tunnels.html +322 -0
  47. package/docs/index.html +239 -0
  48. package/docs/interfaces/client.NgrokConfig.html +179 -0
  49. package/docs/interfaces/datatypes.APIKey.html +262 -0
  50. package/docs/interfaces/datatypes.APIKeyCreate.html +186 -0
  51. package/docs/interfaces/datatypes.APIKeyList.html +205 -0
  52. package/docs/interfaces/datatypes.APIKeyUpdate.html +200 -0
  53. package/docs/interfaces/datatypes.AWSAuth.html +186 -0
  54. package/docs/interfaces/datatypes.AWSCredentials.html +186 -0
  55. package/docs/interfaces/datatypes.AWSRole.html +167 -0
  56. package/docs/interfaces/datatypes.AbuseReport.html +281 -0
  57. package/docs/interfaces/datatypes.AbuseReportCreate.html +186 -0
  58. package/docs/interfaces/datatypes.AbuseReportHostname.html +186 -0
  59. package/docs/interfaces/datatypes.AgentIngress.html +300 -0
  60. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  61. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  62. package/docs/interfaces/datatypes.AgentIngressUpdate.html +200 -0
  63. package/docs/interfaces/datatypes.CertificateAuthority.html +357 -0
  64. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +205 -0
  65. package/docs/interfaces/datatypes.CertificateAuthorityList.html +205 -0
  66. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +200 -0
  67. package/docs/interfaces/datatypes.Credential.html +281 -0
  68. package/docs/interfaces/datatypes.CredentialCreate.html +205 -0
  69. package/docs/interfaces/datatypes.CredentialList.html +205 -0
  70. package/docs/interfaces/datatypes.CredentialUpdate.html +219 -0
  71. package/docs/interfaces/datatypes.Empty.html +130 -0
  72. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +262 -0
  73. package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +176 -0
  74. package/docs/interfaces/datatypes.EndpointCompression.html +167 -0
  75. package/docs/interfaces/datatypes.EndpointCompressionReplace.html +176 -0
  76. package/docs/interfaces/datatypes.EndpointConfiguration.html +490 -0
  77. package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +433 -0
  78. package/docs/interfaces/datatypes.EndpointConfigurationList.html +205 -0
  79. package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +433 -0
  80. package/docs/interfaces/datatypes.EndpointIPPolicy.html +181 -0
  81. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +186 -0
  82. package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +176 -0
  83. package/docs/interfaces/datatypes.EndpointLogging.html +186 -0
  84. package/docs/interfaces/datatypes.EndpointLoggingMutate.html +186 -0
  85. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +176 -0
  86. package/docs/interfaces/datatypes.EndpointMutualTLS.html +186 -0
  87. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +186 -0
  88. package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +176 -0
  89. package/docs/interfaces/datatypes.EndpointOAuth.html +281 -0
  90. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +243 -0
  91. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +281 -0
  92. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +243 -0
  93. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +243 -0
  94. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +224 -0
  95. package/docs/interfaces/datatypes.EndpointOAuthReplace.html +176 -0
  96. package/docs/interfaces/datatypes.EndpointOIDC.html +319 -0
  97. package/docs/interfaces/datatypes.EndpointOIDCReplace.html +176 -0
  98. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +205 -0
  99. package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +176 -0
  100. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +176 -0
  102. package/docs/interfaces/datatypes.EndpointSAML.html +433 -0
  103. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +338 -0
  104. package/docs/interfaces/datatypes.EndpointSAMLReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EndpointTLSTermination.html +205 -0
  106. package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +176 -0
  107. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +205 -0
  108. package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +176 -0
  109. package/docs/interfaces/datatypes.Error.html +204 -0
  110. package/docs/interfaces/datatypes.EventDestination.html +281 -0
  111. package/docs/interfaces/datatypes.EventDestinationCreate.html +224 -0
  112. package/docs/interfaces/datatypes.EventDestinationList.html +205 -0
  113. package/docs/interfaces/datatypes.EventDestinationUpdate.html +243 -0
  114. package/docs/interfaces/datatypes.EventSource.html +186 -0
  115. package/docs/interfaces/datatypes.EventSourceCreate.html +186 -0
  116. package/docs/interfaces/datatypes.EventSourceItem.html +193 -0
  117. package/docs/interfaces/datatypes.EventSourceList.html +186 -0
  118. package/docs/interfaces/datatypes.EventSourcePaging.html +174 -0
  119. package/docs/interfaces/datatypes.EventSourceReplace.html +167 -0
  120. package/docs/interfaces/datatypes.EventSourceUpdate.html +186 -0
  121. package/docs/interfaces/datatypes.EventStream.html +319 -0
  122. package/docs/interfaces/datatypes.EventStreamCreate.html +262 -0
  123. package/docs/interfaces/datatypes.EventStreamList.html +205 -0
  124. package/docs/interfaces/datatypes.EventStreamUpdate.html +262 -0
  125. package/docs/interfaces/datatypes.EventSubscription.html +281 -0
  126. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +224 -0
  127. package/docs/interfaces/datatypes.EventSubscriptionList.html +205 -0
  128. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +243 -0
  129. package/docs/interfaces/datatypes.EventTarget.html +205 -0
  130. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +186 -0
  131. package/docs/interfaces/datatypes.EventTargetFirehose.html +186 -0
  132. package/docs/interfaces/datatypes.EventTargetKinesis.html +186 -0
  133. package/docs/interfaces/datatypes.IPPolicy.html +262 -0
  134. package/docs/interfaces/datatypes.IPPolicyCreate.html +205 -0
  135. package/docs/interfaces/datatypes.IPPolicyList.html +205 -0
  136. package/docs/interfaces/datatypes.IPPolicyRule.html +281 -0
  137. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +224 -0
  138. package/docs/interfaces/datatypes.IPPolicyRuleList.html +205 -0
  139. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +219 -0
  140. package/docs/interfaces/datatypes.IPPolicyUpdate.html +200 -0
  141. package/docs/interfaces/datatypes.IPRestriction.html +300 -0
  142. package/docs/interfaces/datatypes.IPRestrictionCreate.html +243 -0
  143. package/docs/interfaces/datatypes.IPRestrictionList.html +205 -0
  144. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +238 -0
  145. package/docs/interfaces/datatypes.Item.html +167 -0
  146. package/docs/interfaces/datatypes.Paging.html +176 -0
  147. package/docs/interfaces/datatypes.Ref.html +186 -0
  148. package/docs/interfaces/datatypes.ReservedAddr.html +300 -0
  149. package/docs/interfaces/datatypes.ReservedAddrCreate.html +224 -0
  150. package/docs/interfaces/datatypes.ReservedAddrList.html +205 -0
  151. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +219 -0
  152. package/docs/interfaces/datatypes.ReservedDomain.html +414 -0
  153. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +224 -0
  154. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +186 -0
  155. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +186 -0
  156. package/docs/interfaces/datatypes.ReservedDomainCreate.html +300 -0
  157. package/docs/interfaces/datatypes.ReservedDomainList.html +205 -0
  158. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +276 -0
  159. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +281 -0
  160. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +243 -0
  161. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +205 -0
  162. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +200 -0
  163. package/docs/interfaces/datatypes.SSHCredential.html +281 -0
  164. package/docs/interfaces/datatypes.SSHCredentialCreate.html +224 -0
  165. package/docs/interfaces/datatypes.SSHCredentialList.html +205 -0
  166. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +219 -0
  167. package/docs/interfaces/datatypes.SSHHostCertificate.html +376 -0
  168. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +281 -0
  169. package/docs/interfaces/datatypes.SSHHostCertificateList.html +205 -0
  170. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +200 -0
  171. package/docs/interfaces/datatypes.SSHUserCertificate.html +414 -0
  172. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +319 -0
  173. package/docs/interfaces/datatypes.SSHUserCertificateList.html +205 -0
  174. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +200 -0
  175. package/docs/interfaces/datatypes.TLSCertificate.html +547 -0
  176. package/docs/interfaces/datatypes.TLSCertificateCreate.html +224 -0
  177. package/docs/interfaces/datatypes.TLSCertificateList.html +205 -0
  178. package/docs/interfaces/datatypes.TLSCertificateSANs.html +186 -0
  179. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +200 -0
  180. package/docs/interfaces/datatypes.Tunnel.html +281 -0
  181. package/docs/interfaces/datatypes.TunnelList.html +205 -0
  182. package/docs/interfaces/datatypes.TunnelSession.html +338 -0
  183. package/docs/interfaces/datatypes.TunnelSessionList.html +205 -0
  184. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +162 -0
  185. package/docs/modules/client.html +137 -0
  186. package/docs/modules/datatypes.html +668 -0
  187. package/docs/modules/services.html +260 -0
  188. package/docs/modules.html +119 -0
  189. package/lib/client.d.ts +145 -0
  190. package/lib/client.d.ts.map +1 -0
  191. package/lib/client.js +102 -0
  192. package/lib/client.js.map +1 -0
  193. package/lib/{types.d.ts → datatypes.d.ts} +620 -816
  194. package/lib/datatypes.d.ts.map +1 -0
  195. package/lib/{types.js → datatypes.js} +1 -1
  196. package/lib/datatypes.js.map +1 -0
  197. package/lib/index.d.ts +3 -314
  198. package/lib/index.d.ts.map +1 -0
  199. package/lib/index.js +25 -887
  200. package/lib/index.js.map +1 -1
  201. package/lib/services.d.ts +773 -0
  202. package/lib/services.d.ts.map +1 -0
  203. package/lib/services.js +2761 -0
  204. package/lib/services.js.map +1 -0
  205. package/lib/util.d.ts +5 -0
  206. package/lib/util.d.ts.map +1 -0
  207. package/lib/util.js +53 -0
  208. package/lib/util.js.map +1 -0
  209. package/package.json +12 -3
  210. package/src/client.ts +265 -0
  211. package/src/{types.ts → datatypes.ts} +648 -869
  212. package/src/index.ts +2 -616
  213. package/src/services.ts +2560 -0
  214. package/src/util.ts +48 -0
  215. package/test/apikey.test.js +44 -30
  216. package/test/endpointConfigurations.test.js +38 -34
  217. package/tsconfig.json +17 -7
  218. package/lib/types.js.map +0 -1
package/docs/interfaces/datatypes.SSHCredential.html ADDED
@@ -0,0 +1,281 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>SSHCredential | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHCredential.html">SSHCredential</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SSHCredential</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">SSHCredential</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#acl" class="tsd-kind-icon">acl</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredential.html#uri" class="tsd-kind-icon">uri</a></li>
93
+ </ul>
94
+ </section>
95
+ </div>
96
+ </section>
97
+ </section>
98
+ <section class="tsd-panel-group tsd-member-group ">
99
+ <h2>Properties</h2>
100
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
101
+ <a name="acl" class="tsd-anchor"></a>
102
+ <h3>acl</h3>
103
+ <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>
104
+ <aside class="tsd-sources">
105
+ <ul>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1298">datatypes.ts:1298</a></li>
107
+ </ul>
108
+ </aside>
109
+ <div class="tsd-comment tsd-typography">
110
+ <div class="lead">
111
+ <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 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>bind:example.ngrok.io</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>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
112
+ </div>
113
+ </div>
114
+ </section>
115
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
+ <a name="createdAt" class="tsd-anchor"></a>
117
+ <h3>created<wbr>At</h3>
118
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
+ <aside class="tsd-sources">
120
+ <ul>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1290">datatypes.ts:1290</a></li>
122
+ </ul>
123
+ </aside>
124
+ <div class="tsd-comment tsd-typography">
125
+ <div class="lead">
126
+ <p>timestamp when the ssh credential was created, RFC 3339 format</p>
127
+ </div>
128
+ </div>
129
+ </section>
130
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
131
+ <a name="description" class="tsd-anchor"></a>
132
+ <h3>description</h3>
133
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
+ <aside class="tsd-sources">
135
+ <ul>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1292">datatypes.ts:1292</a></li>
137
+ </ul>
138
+ </aside>
139
+ <div class="tsd-comment tsd-typography">
140
+ <div class="lead">
141
+ <p>human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p>
142
+ </div>
143
+ </div>
144
+ </section>
145
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
+ <a name="id" class="tsd-anchor"></a>
147
+ <h3>id</h3>
148
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
+ <aside class="tsd-sources">
150
+ <ul>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1286">datatypes.ts:1286</a></li>
152
+ </ul>
153
+ </aside>
154
+ <div class="tsd-comment tsd-typography">
155
+ <div class="lead">
156
+ <p>unique ssh credential resource identifier</p>
157
+ </div>
158
+ </div>
159
+ </section>
160
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
161
+ <a name="metadata" class="tsd-anchor"></a>
162
+ <h3>metadata</h3>
163
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
+ <aside class="tsd-sources">
165
+ <ul>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1294">datatypes.ts:1294</a></li>
167
+ </ul>
168
+ </aside>
169
+ <div class="tsd-comment tsd-typography">
170
+ <div class="lead">
171
+ <p>arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p>
172
+ </div>
173
+ </div>
174
+ </section>
175
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
176
+ <a name="publicKey" class="tsd-anchor"></a>
177
+ <h3>public<wbr>Key</h3>
178
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
179
+ <aside class="tsd-sources">
180
+ <ul>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1296">datatypes.ts:1296</a></li>
182
+ </ul>
183
+ </aside>
184
+ <div class="tsd-comment tsd-typography">
185
+ <div class="lead">
186
+ <p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
187
+ </div>
188
+ </div>
189
+ </section>
190
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
191
+ <a name="uri" class="tsd-anchor"></a>
192
+ <h3>uri</h3>
193
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
194
+ <aside class="tsd-sources">
195
+ <ul>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1288">datatypes.ts:1288</a></li>
197
+ </ul>
198
+ </aside>
199
+ <div class="tsd-comment tsd-typography">
200
+ <div class="lead">
201
+ <p>URI of the ssh credential API resource</p>
202
+ </div>
203
+ </div>
204
+ </section>
205
+ </section>
206
+ </div>
207
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
208
+ <nav class="tsd-navigation primary">
209
+ <ul>
210
+ <li class=" ">
211
+ <a href="../modules.html">Modules</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/client.html">client</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/datatypes.html">datatypes</a>
218
+ </li>
219
+ <li class=" tsd-kind-module">
220
+ <a href="../modules/services.html">services</a>
221
+ </li>
222
+ </ul>
223
+ </nav>
224
+ <nav class="tsd-navigation secondary menu-sticky">
225
+ <ul class="before-current">
226
+ </ul>
227
+ <ul class="current">
228
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
229
+ <a href="datatypes.SSHCredential.html" class="tsd-kind-icon">SSHCredential</a>
230
+ <ul>
231
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
232
+ <a href="datatypes.SSHCredential.html#acl" class="tsd-kind-icon">acl</a>
233
+ </li>
234
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
235
+ <a href="datatypes.SSHCredential.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
236
+ </li>
237
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
238
+ <a href="datatypes.SSHCredential.html#description" class="tsd-kind-icon">description</a>
239
+ </li>
240
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
241
+ <a href="datatypes.SSHCredential.html#id" class="tsd-kind-icon">id</a>
242
+ </li>
243
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
244
+ <a href="datatypes.SSHCredential.html#metadata" class="tsd-kind-icon">metadata</a>
245
+ </li>
246
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
247
+ <a href="datatypes.SSHCredential.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
248
+ </li>
249
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
250
+ <a href="datatypes.SSHCredential.html#uri" class="tsd-kind-icon">uri</a>
251
+ </li>
252
+ </ul>
253
+ </li>
254
+ </ul>
255
+ <ul class="after-current">
256
+ </ul>
257
+ </nav>
258
+ </div>
259
+ </div>
260
+ </div>
261
+ <footer class="with-border-bottom">
262
+ <div class="container">
263
+ <h2>Legend</h2>
264
+ <div class="tsd-legend-group">
265
+ <ul class="tsd-legend">
266
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
267
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
268
+ </ul>
269
+ <ul class="tsd-legend">
270
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
271
+ </ul>
272
+ </div>
273
+ </div>
274
+ </footer>
275
+ <div class="container tsd-generator">
276
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
277
+ </div>
278
+ <div class="overlay"></div>
279
+ <script src="../assets/js/main.js"></script>
280
+ </body>
281
+ </html>
package/docs/interfaces/datatypes.SSHCredentialCreate.html ADDED
@@ -0,0 +1,224 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>SSHCredentialCreate | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SSHCredentialCreate.html">SSHCredentialCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SSHCredentialCreate</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">SSHCredentialCreate</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#acl" class="tsd-kind-icon">acl</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
90
+ </ul>
91
+ </section>
92
+ </div>
93
+ </section>
94
+ </section>
95
+ <section class="tsd-panel-group tsd-member-group ">
96
+ <h2>Properties</h2>
97
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
98
+ <a name="acl" class="tsd-anchor"></a>
99
+ <h3>acl</h3>
100
+ <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>
101
+ <aside class="tsd-sources">
102
+ <ul>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1269">datatypes.ts:1269</a></li>
104
+ </ul>
105
+ </aside>
106
+ <div class="tsd-comment tsd-typography">
107
+ <div class="lead">
108
+ <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 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>bind:example.ngrok.io</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>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
109
+ </div>
110
+ </div>
111
+ </section>
112
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
+ <a name="description" class="tsd-anchor"></a>
114
+ <h3>description</h3>
115
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
+ <aside class="tsd-sources">
117
+ <ul>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1265">datatypes.ts:1265</a></li>
119
+ </ul>
120
+ </aside>
121
+ <div class="tsd-comment tsd-typography">
122
+ <div class="lead">
123
+ <p>human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p>
124
+ </div>
125
+ </div>
126
+ </section>
127
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
+ <a name="metadata" class="tsd-anchor"></a>
129
+ <h3>metadata</h3>
130
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1267">datatypes.ts:1267</a></li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p>
139
+ </div>
140
+ </div>
141
+ </section>
142
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
+ <a name="publicKey" class="tsd-anchor"></a>
144
+ <h3>public<wbr>Key</h3>
145
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
+ <aside class="tsd-sources">
147
+ <ul>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1271">datatypes.ts:1271</a></li>
149
+ </ul>
150
+ </aside>
151
+ <div class="tsd-comment tsd-typography">
152
+ <div class="lead">
153
+ <p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
154
+ </div>
155
+ </div>
156
+ </section>
157
+ </section>
158
+ </div>
159
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
160
+ <nav class="tsd-navigation primary">
161
+ <ul>
162
+ <li class=" ">
163
+ <a href="../modules.html">Modules</a>
164
+ </li>
165
+ <li class=" tsd-kind-module">
166
+ <a href="../modules/client.html">client</a>
167
+ </li>
168
+ <li class="current tsd-kind-module">
169
+ <a href="../modules/datatypes.html">datatypes</a>
170
+ </li>
171
+ <li class=" tsd-kind-module">
172
+ <a href="../modules/services.html">services</a>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <nav class="tsd-navigation secondary menu-sticky">
177
+ <ul class="before-current">
178
+ </ul>
179
+ <ul class="current">
180
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
181
+ <a href="datatypes.SSHCredentialCreate.html" class="tsd-kind-icon">SSHCredential<wbr>Create</a>
182
+ <ul>
183
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
184
+ <a href="datatypes.SSHCredentialCreate.html#acl" class="tsd-kind-icon">acl</a>
185
+ </li>
186
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
187
+ <a href="datatypes.SSHCredentialCreate.html#description" class="tsd-kind-icon">description</a>
188
+ </li>
189
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
190
+ <a href="datatypes.SSHCredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a>
191
+ </li>
192
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
193
+ <a href="datatypes.SSHCredentialCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
194
+ </li>
195
+ </ul>
196
+ </li>
197
+ </ul>
198
+ <ul class="after-current">
199
+ </ul>
200
+ </nav>
201
+ </div>
202
+ </div>
203
+ </div>
204
+ <footer class="with-border-bottom">
205
+ <div class="container">
206
+ <h2>Legend</h2>
207
+ <div class="tsd-legend-group">
208
+ <ul class="tsd-legend">
209
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
210
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
211
+ </ul>
212
+ <ul class="tsd-legend">
213
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </footer>
218
+ <div class="container tsd-generator">
219
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
220
+ </div>
221
+ <div class="overlay"></div>
222
+ <script src="../assets/js/main.js"></script>
223
+ </body>
224
+ </html>