@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.SSHUserCertificateCreate.html ADDED
@@ -0,0 +1,319 @@
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>SSHUserCertificateCreate | @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.SSHUserCertificateCreate.html">SSHUserCertificateCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SSHUserCertificateCreate</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">SSHUserCertificateCreate</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.SSHUserCertificateCreate.html#criticalOptions" class="tsd-kind-icon">critical<wbr>Options</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#description" class="tsd-kind-icon">description</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#extensions" class="tsd-kind-icon">extensions</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#principals" class="tsd-kind-icon">principals</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a></li>
95
+ </ul>
96
+ </section>
97
+ </div>
98
+ </section>
99
+ </section>
100
+ <section class="tsd-panel-group tsd-member-group ">
101
+ <h2>Properties</h2>
102
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
103
+ <a name="criticalOptions" class="tsd-anchor"></a>
104
+ <h3>critical<wbr>Options</h3>
105
+ <div class="tsd-signature tsd-kind-icon">critical<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
106
+ <aside class="tsd-sources">
107
+ <ul>
108
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1379">datatypes.ts:1379</a></li>
109
+ </ul>
110
+ </aside>
111
+ <div class="tsd-comment tsd-typography">
112
+ <div class="lead">
113
+ <p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code>force-command</code> and <code>source-address</code>. See <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
114
+ </div>
115
+ </div>
116
+ </section>
117
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
118
+ <a name="description" class="tsd-anchor"></a>
119
+ <h3>description</h3>
120
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121
+ <aside class="tsd-sources">
122
+ <ul>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1387">datatypes.ts:1387</a></li>
124
+ </ul>
125
+ </aside>
126
+ <div class="tsd-comment tsd-typography">
127
+ <div class="lead">
128
+ <p>human-readable description of this SSH User Certificate. optional, max 255 bytes.</p>
129
+ </div>
130
+ </div>
131
+ </section>
132
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
133
+ <a name="extensions" class="tsd-anchor"></a>
134
+ <h3>extensions</h3>
135
+ <div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
136
+ <aside class="tsd-sources">
137
+ <ul>
138
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1381">datatypes.ts:1381</a></li>
139
+ </ul>
140
+ </aside>
141
+ <div class="tsd-comment tsd-typography">
142
+ <div class="lead">
143
+ <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>{&quot;permit-pty&quot;: &quot;&quot;, &quot;permit-user-rc&quot;: &quot;&quot;}</code> OpenSSH understands a number of predefined extensions. See <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys">the OpenSSH certificate protocol spec</a> for additional details.</p>
144
+ </div>
145
+ </div>
146
+ </section>
147
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
148
+ <a name="metadata" class="tsd-anchor"></a>
149
+ <h3>metadata</h3>
150
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
151
+ <aside class="tsd-sources">
152
+ <ul>
153
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1389">datatypes.ts:1389</a></li>
154
+ </ul>
155
+ </aside>
156
+ <div class="tsd-comment tsd-typography">
157
+ <div class="lead">
158
+ <p>arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p>
159
+ </div>
160
+ </div>
161
+ </section>
162
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
163
+ <a name="principals" class="tsd-anchor"></a>
164
+ <h3>principals</h3>
165
+ <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
166
+ <aside class="tsd-sources">
167
+ <ul>
168
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1377">datatypes.ts:1377</a></li>
169
+ </ul>
170
+ </aside>
171
+ <div class="tsd-comment tsd-typography">
172
+ <div class="lead">
173
+ <p>the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</p>
174
+ </div>
175
+ </div>
176
+ </section>
177
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
178
+ <a name="publicKey" class="tsd-anchor"></a>
179
+ <h3>public<wbr>Key</h3>
180
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
181
+ <aside class="tsd-sources">
182
+ <ul>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1375">datatypes.ts:1375</a></li>
184
+ </ul>
185
+ </aside>
186
+ <div class="tsd-comment tsd-typography">
187
+ <div class="lead">
188
+ <p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
189
+ </div>
190
+ </div>
191
+ </section>
192
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
193
+ <a name="sshCertificateAuthorityId" class="tsd-anchor"></a>
194
+ <h3>ssh<wbr>Certificate<wbr>Authority<wbr>Id</h3>
195
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
196
+ <aside class="tsd-sources">
197
+ <ul>
198
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1373">datatypes.ts:1373</a></li>
199
+ </ul>
200
+ </aside>
201
+ <div class="tsd-comment tsd-typography">
202
+ <div class="lead">
203
+ <p>the ssh certificate authority that is used to sign this ssh user certificate</p>
204
+ </div>
205
+ </div>
206
+ </section>
207
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
208
+ <a name="validAfter" class="tsd-anchor"></a>
209
+ <h3>valid<wbr>After</h3>
210
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
211
+ <aside class="tsd-sources">
212
+ <ul>
213
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1383">datatypes.ts:1383</a></li>
214
+ </ul>
215
+ </aside>
216
+ <div class="tsd-comment tsd-typography">
217
+ <div class="lead">
218
+ <p>The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</p>
219
+ </div>
220
+ </div>
221
+ </section>
222
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
223
+ <a name="validUntil" class="tsd-anchor"></a>
224
+ <h3>valid<wbr>Until</h3>
225
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
226
+ <aside class="tsd-sources">
227
+ <ul>
228
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1385">datatypes.ts:1385</a></li>
229
+ </ul>
230
+ </aside>
231
+ <div class="tsd-comment tsd-typography">
232
+ <div class="lead">
233
+ <p>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>valid_before</code>.</p>
234
+ </div>
235
+ </div>
236
+ </section>
237
+ </section>
238
+ </div>
239
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
240
+ <nav class="tsd-navigation primary">
241
+ <ul>
242
+ <li class=" ">
243
+ <a href="../modules.html">Modules</a>
244
+ </li>
245
+ <li class=" tsd-kind-module">
246
+ <a href="../modules/client.html">client</a>
247
+ </li>
248
+ <li class="current tsd-kind-module">
249
+ <a href="../modules/datatypes.html">datatypes</a>
250
+ </li>
251
+ <li class=" tsd-kind-module">
252
+ <a href="../modules/services.html">services</a>
253
+ </li>
254
+ </ul>
255
+ </nav>
256
+ <nav class="tsd-navigation secondary menu-sticky">
257
+ <ul class="before-current">
258
+ </ul>
259
+ <ul class="current">
260
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
261
+ <a href="datatypes.SSHUserCertificateCreate.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>Create</a>
262
+ <ul>
263
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
264
+ <a href="datatypes.SSHUserCertificateCreate.html#criticalOptions" class="tsd-kind-icon">critical<wbr>Options</a>
265
+ </li>
266
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
267
+ <a href="datatypes.SSHUserCertificateCreate.html#description" class="tsd-kind-icon">description</a>
268
+ </li>
269
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
270
+ <a href="datatypes.SSHUserCertificateCreate.html#extensions" class="tsd-kind-icon">extensions</a>
271
+ </li>
272
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
273
+ <a href="datatypes.SSHUserCertificateCreate.html#metadata" class="tsd-kind-icon">metadata</a>
274
+ </li>
275
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
276
+ <a href="datatypes.SSHUserCertificateCreate.html#principals" class="tsd-kind-icon">principals</a>
277
+ </li>
278
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
279
+ <a href="datatypes.SSHUserCertificateCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
280
+ </li>
281
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
282
+ <a href="datatypes.SSHUserCertificateCreate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a>
283
+ </li>
284
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
285
+ <a href="datatypes.SSHUserCertificateCreate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a>
286
+ </li>
287
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
288
+ <a href="datatypes.SSHUserCertificateCreate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a>
289
+ </li>
290
+ </ul>
291
+ </li>
292
+ </ul>
293
+ <ul class="after-current">
294
+ </ul>
295
+ </nav>
296
+ </div>
297
+ </div>
298
+ </div>
299
+ <footer class="with-border-bottom">
300
+ <div class="container">
301
+ <h2>Legend</h2>
302
+ <div class="tsd-legend-group">
303
+ <ul class="tsd-legend">
304
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
305
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
306
+ </ul>
307
+ <ul class="tsd-legend">
308
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
309
+ </ul>
310
+ </div>
311
+ </div>
312
+ </footer>
313
+ <div class="container tsd-generator">
314
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
315
+ </div>
316
+ <div class="overlay"></div>
317
+ <script src="../assets/js/main.js"></script>
318
+ </body>
319
+ </html>
package/docs/interfaces/datatypes.SSHUserCertificateList.html ADDED
@@ -0,0 +1,205 @@
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>SSHUserCertificateList | @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.SSHUserCertificateList.html">SSHUserCertificateList</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SSHUserCertificateList</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">SSHUserCertificateList</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.SSHUserCertificateList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateList.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHUserCertificateList.html#uri" class="tsd-kind-icon">uri</a></li>
89
+ </ul>
90
+ </section>
91
+ </div>
92
+ </section>
93
+ </section>
94
+ <section class="tsd-panel-group tsd-member-group ">
95
+ <h2>Properties</h2>
96
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
97
+ <a name="nextPageUri" class="tsd-anchor"></a>
98
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
99
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
100
+ <aside class="tsd-sources">
101
+ <ul>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1437">datatypes.ts:1437</a></li>
103
+ </ul>
104
+ </aside>
105
+ <div class="tsd-comment tsd-typography">
106
+ <div class="lead">
107
+ <p>URI of the next page, or null if there is no next page</p>
108
+ </div>
109
+ </div>
110
+ </section>
111
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
+ <a name="sshUserCertificates" class="tsd-anchor"></a>
113
+ <h3>ssh<wbr>User<wbr>Certificates</h3>
114
+ <div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHUserCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHUserCertificate</a><span class="tsd-signature-symbol">[]</span></div>
115
+ <aside class="tsd-sources">
116
+ <ul>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1433">datatypes.ts:1433</a></li>
118
+ </ul>
119
+ </aside>
120
+ <div class="tsd-comment tsd-typography">
121
+ <div class="lead">
122
+ <p>the list of all ssh user certificates on this account</p>
123
+ </div>
124
+ </div>
125
+ </section>
126
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
+ <a name="uri" class="tsd-anchor"></a>
128
+ <h3>uri</h3>
129
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
+ <aside class="tsd-sources">
131
+ <ul>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1435">datatypes.ts:1435</a></li>
133
+ </ul>
134
+ </aside>
135
+ <div class="tsd-comment tsd-typography">
136
+ <div class="lead">
137
+ <p>URI of the ssh user certificates list API resource</p>
138
+ </div>
139
+ </div>
140
+ </section>
141
+ </section>
142
+ </div>
143
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
144
+ <nav class="tsd-navigation primary">
145
+ <ul>
146
+ <li class=" ">
147
+ <a href="../modules.html">Modules</a>
148
+ </li>
149
+ <li class=" tsd-kind-module">
150
+ <a href="../modules/client.html">client</a>
151
+ </li>
152
+ <li class="current tsd-kind-module">
153
+ <a href="../modules/datatypes.html">datatypes</a>
154
+ </li>
155
+ <li class=" tsd-kind-module">
156
+ <a href="../modules/services.html">services</a>
157
+ </li>
158
+ </ul>
159
+ </nav>
160
+ <nav class="tsd-navigation secondary menu-sticky">
161
+ <ul class="before-current">
162
+ </ul>
163
+ <ul class="current">
164
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
165
+ <a href="datatypes.SSHUserCertificateList.html" class="tsd-kind-icon">SSHUser<wbr>Certificate<wbr>List</a>
166
+ <ul>
167
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
168
+ <a href="datatypes.SSHUserCertificateList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
169
+ </li>
170
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
171
+ <a href="datatypes.SSHUserCertificateList.html#sshUserCertificates" class="tsd-kind-icon">ssh<wbr>User<wbr>Certificates</a>
172
+ </li>
173
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
174
+ <a href="datatypes.SSHUserCertificateList.html#uri" class="tsd-kind-icon">uri</a>
175
+ </li>
176
+ </ul>
177
+ </li>
178
+ </ul>
179
+ <ul class="after-current">
180
+ </ul>
181
+ </nav>
182
+ </div>
183
+ </div>
184
+ </div>
185
+ <footer class="with-border-bottom">
186
+ <div class="container">
187
+ <h2>Legend</h2>
188
+ <div class="tsd-legend-group">
189
+ <ul class="tsd-legend">
190
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
191
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
192
+ </ul>
193
+ <ul class="tsd-legend">
194
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
195
+ </ul>
196
+ </div>
197
+ </div>
198
+ </footer>
199
+ <div class="container tsd-generator">
200
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
201
+ </div>
202
+ <div class="overlay"></div>
203
+ <script src="../assets/js/main.js"></script>
204
+ </body>
205
+ </html>