@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.SSHHostCertificate.html ADDED
@@ -0,0 +1,376 @@
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>SSHHostCertificate | @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.SSHHostCertificate.html">SSHHostCertificate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SSHHostCertificate</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">SSHHostCertificate</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.SSHHostCertificate.html#certificate" class="tsd-kind-icon">certificate</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#keyType" class="tsd-kind-icon">key<wbr>Type</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#principals" class="tsd-kind-icon">principals</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#uri" class="tsd-kind-icon">uri</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHHostCertificate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a></li>
98
+ </ul>
99
+ </section>
100
+ </div>
101
+ </section>
102
+ </section>
103
+ <section class="tsd-panel-group tsd-member-group ">
104
+ <h2>Properties</h2>
105
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106
+ <a name="certificate" class="tsd-anchor"></a>
107
+ <h3>certificate</h3>
108
+ <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
109
+ <aside class="tsd-sources">
110
+ <ul>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1359">datatypes.ts:1359</a></li>
112
+ </ul>
113
+ </aside>
114
+ <div class="tsd-comment tsd-typography">
115
+ <div class="lead">
116
+ <p>the signed SSH certificate in OpenSSH Authorized Keys format. this value should be placed in a <code>-cert.pub</code> certificate file on disk that should be referenced in your <code>sshd_config</code> configuration file with a <code>HostCertificate</code> directive</p>
117
+ </div>
118
+ </div>
119
+ </section>
120
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
121
+ <a name="createdAt" class="tsd-anchor"></a>
122
+ <h3>created<wbr>At</h3>
123
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
124
+ <aside class="tsd-sources">
125
+ <ul>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1341">datatypes.ts:1341</a></li>
127
+ </ul>
128
+ </aside>
129
+ <div class="tsd-comment tsd-typography">
130
+ <div class="lead">
131
+ <p>timestamp when the SSH Host Certificate API resource was created, RFC 3339 format</p>
132
+ </div>
133
+ </div>
134
+ </section>
135
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136
+ <a name="description" class="tsd-anchor"></a>
137
+ <h3>description</h3>
138
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
139
+ <aside class="tsd-sources">
140
+ <ul>
141
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1343">datatypes.ts:1343</a></li>
142
+ </ul>
143
+ </aside>
144
+ <div class="tsd-comment tsd-typography">
145
+ <div class="lead">
146
+ <p>human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p>
147
+ </div>
148
+ </div>
149
+ </section>
150
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
151
+ <a name="id" class="tsd-anchor"></a>
152
+ <h3>id</h3>
153
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
+ <aside class="tsd-sources">
155
+ <ul>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1337">datatypes.ts:1337</a></li>
157
+ </ul>
158
+ </aside>
159
+ <div class="tsd-comment tsd-typography">
160
+ <div class="lead">
161
+ <p>unique identifier for this SSH Host Certificate</p>
162
+ </div>
163
+ </div>
164
+ </section>
165
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
166
+ <a name="keyType" class="tsd-anchor"></a>
167
+ <h3>key<wbr>Type</h3>
168
+ <div class="tsd-signature tsd-kind-icon">key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
169
+ <aside class="tsd-sources">
170
+ <ul>
171
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1349">datatypes.ts:1349</a></li>
172
+ </ul>
173
+ </aside>
174
+ <div class="tsd-comment tsd-typography">
175
+ <div class="lead">
176
+ <p>the key type of the <code>public_key</code>, one of <code>rsa</code>, <code>ecdsa</code> or <code>ed25519</code></p>
177
+ </div>
178
+ </div>
179
+ </section>
180
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
181
+ <a name="metadata" class="tsd-anchor"></a>
182
+ <h3>metadata</h3>
183
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184
+ <aside class="tsd-sources">
185
+ <ul>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1345">datatypes.ts:1345</a></li>
187
+ </ul>
188
+ </aside>
189
+ <div class="tsd-comment tsd-typography">
190
+ <div class="lead">
191
+ <p>arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p>
192
+ </div>
193
+ </div>
194
+ </section>
195
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
196
+ <a name="principals" class="tsd-anchor"></a>
197
+ <h3>principals</h3>
198
+ <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>
199
+ <aside class="tsd-sources">
200
+ <ul>
201
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1353">datatypes.ts:1353</a></li>
202
+ </ul>
203
+ </aside>
204
+ <div class="tsd-comment tsd-typography">
205
+ <div class="lead">
206
+ <p>the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.</p>
207
+ </div>
208
+ </div>
209
+ </section>
210
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
211
+ <a name="publicKey" class="tsd-anchor"></a>
212
+ <h3>public<wbr>Key</h3>
213
+ <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
+ <aside class="tsd-sources">
215
+ <ul>
216
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1347">datatypes.ts:1347</a></li>
217
+ </ul>
218
+ </aside>
219
+ <div class="tsd-comment tsd-typography">
220
+ <div class="lead">
221
+ <p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
222
+ </div>
223
+ </div>
224
+ </section>
225
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
226
+ <a name="sshCertificateAuthorityId" class="tsd-anchor"></a>
227
+ <h3>ssh<wbr>Certificate<wbr>Authority<wbr>Id</h3>
228
+ <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>
229
+ <aside class="tsd-sources">
230
+ <ul>
231
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1351">datatypes.ts:1351</a></li>
232
+ </ul>
233
+ </aside>
234
+ <div class="tsd-comment tsd-typography">
235
+ <div class="lead">
236
+ <p>the ssh certificate authority that is used to sign this ssh host certificate</p>
237
+ </div>
238
+ </div>
239
+ </section>
240
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
241
+ <a name="uri" class="tsd-anchor"></a>
242
+ <h3>uri</h3>
243
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
244
+ <aside class="tsd-sources">
245
+ <ul>
246
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1339">datatypes.ts:1339</a></li>
247
+ </ul>
248
+ </aside>
249
+ <div class="tsd-comment tsd-typography">
250
+ <div class="lead">
251
+ <p>URI of the SSH Host Certificate API resource</p>
252
+ </div>
253
+ </div>
254
+ </section>
255
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
256
+ <a name="validAfter" class="tsd-anchor"></a>
257
+ <h3>valid<wbr>After</h3>
258
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
259
+ <aside class="tsd-sources">
260
+ <ul>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1355">datatypes.ts:1355</a></li>
262
+ </ul>
263
+ </aside>
264
+ <div class="tsd-comment tsd-typography">
265
+ <div class="lead">
266
+ <p>the time when the ssh host certificate becomes valid, in RFC 3339 format.</p>
267
+ </div>
268
+ </div>
269
+ </section>
270
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
271
+ <a name="validUntil" class="tsd-anchor"></a>
272
+ <h3>valid<wbr>Until</h3>
273
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
274
+ <aside class="tsd-sources">
275
+ <ul>
276
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1357">datatypes.ts:1357</a></li>
277
+ </ul>
278
+ </aside>
279
+ <div class="tsd-comment tsd-typography">
280
+ <div class="lead">
281
+ <p>the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
282
+ </div>
283
+ </div>
284
+ </section>
285
+ </section>
286
+ </div>
287
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
288
+ <nav class="tsd-navigation primary">
289
+ <ul>
290
+ <li class=" ">
291
+ <a href="../modules.html">Modules</a>
292
+ </li>
293
+ <li class=" tsd-kind-module">
294
+ <a href="../modules/client.html">client</a>
295
+ </li>
296
+ <li class="current tsd-kind-module">
297
+ <a href="../modules/datatypes.html">datatypes</a>
298
+ </li>
299
+ <li class=" tsd-kind-module">
300
+ <a href="../modules/services.html">services</a>
301
+ </li>
302
+ </ul>
303
+ </nav>
304
+ <nav class="tsd-navigation secondary menu-sticky">
305
+ <ul class="before-current">
306
+ </ul>
307
+ <ul class="current">
308
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
309
+ <a href="datatypes.SSHHostCertificate.html" class="tsd-kind-icon">SSHHost<wbr>Certificate</a>
310
+ <ul>
311
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
312
+ <a href="datatypes.SSHHostCertificate.html#certificate" class="tsd-kind-icon">certificate</a>
313
+ </li>
314
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
315
+ <a href="datatypes.SSHHostCertificate.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
316
+ </li>
317
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
318
+ <a href="datatypes.SSHHostCertificate.html#description" class="tsd-kind-icon">description</a>
319
+ </li>
320
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
321
+ <a href="datatypes.SSHHostCertificate.html#id" class="tsd-kind-icon">id</a>
322
+ </li>
323
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
324
+ <a href="datatypes.SSHHostCertificate.html#keyType" class="tsd-kind-icon">key<wbr>Type</a>
325
+ </li>
326
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
327
+ <a href="datatypes.SSHHostCertificate.html#metadata" class="tsd-kind-icon">metadata</a>
328
+ </li>
329
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
330
+ <a href="datatypes.SSHHostCertificate.html#principals" class="tsd-kind-icon">principals</a>
331
+ </li>
332
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
333
+ <a href="datatypes.SSHHostCertificate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
334
+ </li>
335
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
336
+ <a href="datatypes.SSHHostCertificate.html#sshCertificateAuthorityId" class="tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id</a>
337
+ </li>
338
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
339
+ <a href="datatypes.SSHHostCertificate.html#uri" class="tsd-kind-icon">uri</a>
340
+ </li>
341
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
342
+ <a href="datatypes.SSHHostCertificate.html#validAfter" class="tsd-kind-icon">valid<wbr>After</a>
343
+ </li>
344
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
345
+ <a href="datatypes.SSHHostCertificate.html#validUntil" class="tsd-kind-icon">valid<wbr>Until</a>
346
+ </li>
347
+ </ul>
348
+ </li>
349
+ </ul>
350
+ <ul class="after-current">
351
+ </ul>
352
+ </nav>
353
+ </div>
354
+ </div>
355
+ </div>
356
+ <footer class="with-border-bottom">
357
+ <div class="container">
358
+ <h2>Legend</h2>
359
+ <div class="tsd-legend-group">
360
+ <ul class="tsd-legend">
361
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
362
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
363
+ </ul>
364
+ <ul class="tsd-legend">
365
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
366
+ </ul>
367
+ </div>
368
+ </div>
369
+ </footer>
370
+ <div class="container tsd-generator">
371
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
372
+ </div>
373
+ <div class="overlay"></div>
374
+ <script src="../assets/js/main.js"></script>
375
+ </body>
376
+ </html>