@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.EndpointSAMLMutate.html ADDED
@@ -0,0 +1,338 @@
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>EndpointSAMLMutate | @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.EndpointSAMLMutate.html">EndpointSAMLMutate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface EndpointSAMLMutate</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">EndpointSAMLMutate</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.EndpointSAMLMutate.html#allowIdpInitiated" class="tsd-kind-icon">allow<wbr>Idp<wbr>Initiated</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLMutate.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
96
+ </ul>
97
+ </section>
98
+ </div>
99
+ </section>
100
+ </section>
101
+ <section class="tsd-panel-group tsd-member-group ">
102
+ <h2>Properties</h2>
103
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104
+ <a name="allowIdpInitiated" class="tsd-anchor"></a>
105
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> allow<wbr>Idp<wbr>Initiated</h3>
106
+ <div class="tsd-signature tsd-kind-icon">allow<wbr>Idp<wbr>Initiated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
107
+ <aside class="tsd-sources">
108
+ <ul>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L582">datatypes.ts:582</a></li>
110
+ </ul>
111
+ </aside>
112
+ <div class="tsd-comment tsd-typography">
113
+ <div class="lead">
114
+ <p>If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the <code>RelayState</code> parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.</p>
115
+ </div>
116
+ </div>
117
+ </section>
118
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
+ <a name="authorizedGroups" class="tsd-anchor"></a>
120
+ <h3>authorized<wbr>Groups</h3>
121
+ <div class="tsd-signature tsd-kind-icon">authorized<wbr>Groups<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
122
+ <aside class="tsd-sources">
123
+ <ul>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L584">datatypes.ts:584</a></li>
125
+ </ul>
126
+ </aside>
127
+ <div class="tsd-comment tsd-typography">
128
+ <div class="lead">
129
+ <p>If present, only users who are a member of one of the listed groups may access the target endpoint.</p>
130
+ </div>
131
+ </div>
132
+ </section>
133
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134
+ <a name="cookiePrefix" class="tsd-anchor"></a>
135
+ <h3>cookie<wbr>Prefix</h3>
136
+ <div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137
+ <aside class="tsd-sources">
138
+ <ul>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L572">datatypes.ts:572</a></li>
140
+ </ul>
141
+ </aside>
142
+ <div class="tsd-comment tsd-typography">
143
+ <div class="lead">
144
+ <p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is &#39;ngrok.&#39;</p>
145
+ </div>
146
+ </div>
147
+ </section>
148
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
149
+ <a name="enabled" class="tsd-anchor"></a>
150
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
151
+ <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
152
+ <aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L568">datatypes.ts:568</a></li>
155
+ </ul>
156
+ </aside>
157
+ <div class="tsd-comment tsd-typography">
158
+ <div class="lead">
159
+ <p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
160
+ </div>
161
+ </div>
162
+ </section>
163
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
164
+ <a name="forceAuthn" class="tsd-anchor"></a>
165
+ <h3>force<wbr>Authn</h3>
166
+ <div class="tsd-signature tsd-kind-icon">force<wbr>Authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
167
+ <aside class="tsd-sources">
168
+ <ul>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L580">datatypes.ts:580</a></li>
170
+ </ul>
171
+ </aside>
172
+ <div class="tsd-comment tsd-typography">
173
+ <div class="lead">
174
+ <p>If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.</p>
175
+ </div>
176
+ </div>
177
+ </section>
178
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
179
+ <a name="idpMetadata" class="tsd-anchor"></a>
180
+ <h3>idp<wbr>Metadata</h3>
181
+ <div class="tsd-signature tsd-kind-icon">idp<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
+ <aside class="tsd-sources">
183
+ <ul>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L578">datatypes.ts:578</a></li>
185
+ </ul>
186
+ </aside>
187
+ <div class="tsd-comment tsd-typography">
188
+ <div class="lead">
189
+ <p>The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.</p>
190
+ </div>
191
+ </div>
192
+ </section>
193
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
194
+ <a name="inactivityTimeout" class="tsd-anchor"></a>
195
+ <h3>inactivity<wbr>Timeout</h3>
196
+ <div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
197
+ <aside class="tsd-sources">
198
+ <ul>
199
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L574">datatypes.ts:574</a></li>
200
+ </ul>
201
+ </aside>
202
+ <div class="tsd-comment tsd-typography">
203
+ <div class="lead">
204
+ <p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
205
+ </div>
206
+ </div>
207
+ </section>
208
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
209
+ <a name="maximumDuration" class="tsd-anchor"></a>
210
+ <h3>maximum<wbr>Duration</h3>
211
+ <div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
212
+ <aside class="tsd-sources">
213
+ <ul>
214
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L576">datatypes.ts:576</a></li>
215
+ </ul>
216
+ </aside>
217
+ <div class="tsd-comment tsd-typography">
218
+ <div class="lead">
219
+ <p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
220
+ </div>
221
+ </div>
222
+ </section>
223
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
224
+ <a name="nameidFormat" class="tsd-anchor"></a>
225
+ <h3>nameid<wbr>Format</h3>
226
+ <div class="tsd-signature tsd-kind-icon">nameid<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227
+ <aside class="tsd-sources">
228
+ <ul>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L586">datatypes.ts:586</a></li>
230
+ </ul>
231
+ </aside>
232
+ <div class="tsd-comment tsd-typography">
233
+ <div class="lead">
234
+ <p>Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of <code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code> will be used. A subset of the allowed values enumerated by the SAML specification are supported.</p>
235
+ </div>
236
+ </div>
237
+ </section>
238
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
239
+ <a name="optionsPassthrough" class="tsd-anchor"></a>
240
+ <h3>options<wbr>Passthrough</h3>
241
+ <div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
242
+ <aside class="tsd-sources">
243
+ <ul>
244
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L570">datatypes.ts:570</a></li>
245
+ </ul>
246
+ </aside>
247
+ <div class="tsd-comment tsd-typography">
248
+ <div class="lead">
249
+ <p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
250
+ </div>
251
+ </div>
252
+ </section>
253
+ </section>
254
+ </div>
255
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
256
+ <nav class="tsd-navigation primary">
257
+ <ul>
258
+ <li class=" ">
259
+ <a href="../modules.html">Modules</a>
260
+ </li>
261
+ <li class=" tsd-kind-module">
262
+ <a href="../modules/client.html">client</a>
263
+ </li>
264
+ <li class="current tsd-kind-module">
265
+ <a href="../modules/datatypes.html">datatypes</a>
266
+ </li>
267
+ <li class=" tsd-kind-module">
268
+ <a href="../modules/services.html">services</a>
269
+ </li>
270
+ </ul>
271
+ </nav>
272
+ <nav class="tsd-navigation secondary menu-sticky">
273
+ <ul class="before-current">
274
+ </ul>
275
+ <ul class="current">
276
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
277
+ <a href="datatypes.EndpointSAMLMutate.html" class="tsd-kind-icon">EndpointSAMLMutate</a>
278
+ <ul>
279
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
280
+ <a href="datatypes.EndpointSAMLMutate.html#allowIdpInitiated" class="tsd-kind-icon">allow<wbr>Idp<wbr>Initiated</a>
281
+ </li>
282
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
283
+ <a href="datatypes.EndpointSAMLMutate.html#authorizedGroups" class="tsd-kind-icon">authorized<wbr>Groups</a>
284
+ </li>
285
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
286
+ <a href="datatypes.EndpointSAMLMutate.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
287
+ </li>
288
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
289
+ <a href="datatypes.EndpointSAMLMutate.html#enabled" class="tsd-kind-icon">enabled</a>
290
+ </li>
291
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
292
+ <a href="datatypes.EndpointSAMLMutate.html#forceAuthn" class="tsd-kind-icon">force<wbr>Authn</a>
293
+ </li>
294
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
295
+ <a href="datatypes.EndpointSAMLMutate.html#idpMetadata" class="tsd-kind-icon">idp<wbr>Metadata</a>
296
+ </li>
297
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
298
+ <a href="datatypes.EndpointSAMLMutate.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
299
+ </li>
300
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
301
+ <a href="datatypes.EndpointSAMLMutate.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
302
+ </li>
303
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
304
+ <a href="datatypes.EndpointSAMLMutate.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a>
305
+ </li>
306
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
307
+ <a href="datatypes.EndpointSAMLMutate.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
308
+ </li>
309
+ </ul>
310
+ </li>
311
+ </ul>
312
+ <ul class="after-current">
313
+ </ul>
314
+ </nav>
315
+ </div>
316
+ </div>
317
+ </div>
318
+ <footer class="with-border-bottom">
319
+ <div class="container">
320
+ <h2>Legend</h2>
321
+ <div class="tsd-legend-group">
322
+ <ul class="tsd-legend">
323
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
324
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
325
+ </ul>
326
+ <ul class="tsd-legend">
327
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
328
+ </ul>
329
+ </div>
330
+ </div>
331
+ </footer>
332
+ <div class="container tsd-generator">
333
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
334
+ </div>
335
+ <div class="overlay"></div>
336
+ <script src="../assets/js/main.js"></script>
337
+ </body>
338
+ </html>
package/docs/interfaces/datatypes.EndpointSAMLReplace.html ADDED
@@ -0,0 +1,176 @@
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>EndpointSAMLReplace | @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.EndpointSAMLReplace.html">EndpointSAMLReplace</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface EndpointSAMLReplace</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">EndpointSAMLReplace</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.EndpointSAMLReplace.html#id" class="tsd-kind-icon">id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAMLReplace.html#module" class="tsd-kind-icon">module</a></li>
88
+ </ul>
89
+ </section>
90
+ </div>
91
+ </section>
92
+ </section>
93
+ <section class="tsd-panel-group tsd-member-group ">
94
+ <h2>Properties</h2>
95
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
+ <a name="id" class="tsd-anchor"></a>
97
+ <h3>id</h3>
98
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
+ <aside class="tsd-sources">
100
+ <ul>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1058">datatypes.ts:1058</a></li>
102
+ </ul>
103
+ </aside>
104
+ </section>
105
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
106
+ <a name="module" class="tsd-anchor"></a>
107
+ <h3>module</h3>
108
+ <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></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#L1059">datatypes.ts:1059</a></li>
112
+ </ul>
113
+ </aside>
114
+ </section>
115
+ </section>
116
+ </div>
117
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
118
+ <nav class="tsd-navigation primary">
119
+ <ul>
120
+ <li class=" ">
121
+ <a href="../modules.html">Modules</a>
122
+ </li>
123
+ <li class=" tsd-kind-module">
124
+ <a href="../modules/client.html">client</a>
125
+ </li>
126
+ <li class="current tsd-kind-module">
127
+ <a href="../modules/datatypes.html">datatypes</a>
128
+ </li>
129
+ <li class=" tsd-kind-module">
130
+ <a href="../modules/services.html">services</a>
131
+ </li>
132
+ </ul>
133
+ </nav>
134
+ <nav class="tsd-navigation secondary menu-sticky">
135
+ <ul class="before-current">
136
+ </ul>
137
+ <ul class="current">
138
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
139
+ <a href="datatypes.EndpointSAMLReplace.html" class="tsd-kind-icon">EndpointSAMLReplace</a>
140
+ <ul>
141
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
142
+ <a href="datatypes.EndpointSAMLReplace.html#id" class="tsd-kind-icon">id</a>
143
+ </li>
144
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
145
+ <a href="datatypes.EndpointSAMLReplace.html#module" class="tsd-kind-icon">module</a>
146
+ </li>
147
+ </ul>
148
+ </li>
149
+ </ul>
150
+ <ul class="after-current">
151
+ </ul>
152
+ </nav>
153
+ </div>
154
+ </div>
155
+ </div>
156
+ <footer class="with-border-bottom">
157
+ <div class="container">
158
+ <h2>Legend</h2>
159
+ <div class="tsd-legend-group">
160
+ <ul class="tsd-legend">
161
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
162
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
163
+ </ul>
164
+ <ul class="tsd-legend">
165
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
166
+ </ul>
167
+ </div>
168
+ </div>
169
+ </footer>
170
+ <div class="container tsd-generator">
171
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
172
+ </div>
173
+ <div class="overlay"></div>
174
+ <script src="../assets/js/main.js"></script>
175
+ </body>
176
+ </html>