@ngrok/ngrok-api 0.3.0 → 0.7.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.
- package/README.md +0 -28
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +191 -100
- package/docs/classes/services.APIKeys.html +6 -105
- package/docs/classes/services.AbuseReports.html +3 -102
- package/docs/classes/services.AgentIngresses.html +6 -105
- package/docs/classes/services.CertificateAuthorities.html +6 -105
- package/docs/classes/services.Credentials.html +6 -105
- package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
- package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
- package/docs/classes/{services.EndpointCircuitBreakerModule.html → services.EdgeRouteIPRestrictionModule.html} +28 -127
- package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
- package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
- package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
- package/docs/classes/services.EdgesHTTPS.html +343 -0
- package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
- package/docs/classes/services.EdgesTCP.html +343 -0
- package/docs/classes/services.EdgesTLS.html +343 -0
- package/docs/classes/services.Endpoints.html +256 -0
- package/docs/classes/services.EventDestinations.html +7 -106
- package/docs/classes/services.EventSources.html +6 -105
- package/docs/classes/services.EventSubscriptions.html +6 -105
- package/docs/classes/services.FailoverBackends.html +353 -0
- package/docs/classes/services.HTTPResponseBackends.html +318 -0
- package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
- package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
- package/docs/classes/services.IPPolicies.html +6 -105
- package/docs/classes/services.IPPolicyRules.html +6 -105
- package/docs/classes/services.IPRestrictions.html +7 -106
- package/docs/classes/services.ReservedAddrs.html +6 -137
- package/docs/classes/services.ReservedDomains.html +8 -171
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
- package/docs/classes/services.SSHCredentials.html +6 -105
- package/docs/classes/services.SSHHostCertificates.html +6 -105
- package/docs/classes/services.SSHUserCertificates.html +6 -105
- package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
- package/docs/classes/services.TLSCertificates.html +6 -105
- package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
- package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +351 -0
- package/docs/classes/services.TunnelSessions.html +6 -105
- package/docs/classes/services.Tunnels.html +34 -101
- package/docs/classes/{services.EventStreams.html → services.WeightedBackends.html} +51 -140
- package/docs/index.html +0 -27
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +6 -6
- package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +8 -8
- package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +7 -7
- package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
- package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeRouteItem.html} +27 -17
- package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
- package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
- package/docs/interfaces/datatypes.Endpoint.html +395 -0
- package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
- package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +205 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +167 -0
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventTarget.html +3 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.FailoverBackend.html} +44 -44
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
- package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.HTTPResponseBackendUpdate.html} +40 -45
- package/docs/interfaces/{datatypes.EventStream.html → datatypes.HTTPSEdge.html} +58 -63
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
- package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.HTTPSEdgeList.html} +20 -20
- package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRoute.html} +123 -104
- package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
- package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRouteUpdate.html} +115 -77
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.IPPolicy.html +5 -24
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -50
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +7 -7
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +295 -0
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +323 -0
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
- package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
- package/docs/interfaces/datatypes.Tunnel.html +85 -9
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.WeightedBackend.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
- package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.WeightedBackendList.html} +19 -19
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
- package/docs/modules/datatypes.html +197 -69
- package/docs/modules/services.html +85 -29
- package/lib/client.d.ts +53 -19
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +42 -18
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +570 -236
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +358 -138
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +1367 -528
- package/lib/services.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +95 -38
- package/src/datatypes.ts +618 -252
- package/src/services.ts +1363 -543
- package/docs/classes/services.EndpointCompressionModule.html +0 -369
- package/docs/classes/services.EndpointConfigurations.html +0 -451
- package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
- package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
- package/test/endpointConfigurations.test.js +0 -67
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
<div class="tsd-signature tsd-kind-icon">facebook<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthFacebook.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthFacebook</a></div>
|
|
101
101
|
<aside class="tsd-sources">
|
|
102
102
|
<ul>
|
|
103
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L531">datatypes.ts:531</a></li>
|
|
104
104
|
</ul>
|
|
105
105
|
</aside>
|
|
106
106
|
<div class="tsd-comment tsd-typography">
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
<div class="tsd-signature tsd-kind-icon">github<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGitHub.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGitHub</a></div>
|
|
116
116
|
<aside class="tsd-sources">
|
|
117
117
|
<ul>
|
|
118
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L529">datatypes.ts:529</a></li>
|
|
119
119
|
</ul>
|
|
120
120
|
</aside>
|
|
121
121
|
<div class="tsd-comment tsd-typography">
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
<div class="tsd-signature tsd-kind-icon">google<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGoogle.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGoogle</a></div>
|
|
131
131
|
<aside class="tsd-sources">
|
|
132
132
|
<ul>
|
|
133
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L535">datatypes.ts:535</a></li>
|
|
134
134
|
</ul>
|
|
135
135
|
</aside>
|
|
136
136
|
<div class="tsd-comment tsd-typography">
|
|
@@ -145,7 +145,7 @@
|
|
|
145
145
|
<div class="tsd-signature tsd-kind-icon">microsoft<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthMicrosoft.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthMicrosoft</a></div>
|
|
146
146
|
<aside class="tsd-sources">
|
|
147
147
|
<ul>
|
|
148
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
148
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L533">datatypes.ts:533</a></li>
|
|
149
149
|
</ul>
|
|
150
150
|
</aside>
|
|
151
151
|
<div class="tsd-comment tsd-typography">
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
106
106
|
<aside class="tsd-sources">
|
|
107
107
|
<ul>
|
|
108
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
108
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L664">datatypes.ts:664</a></li>
|
|
109
109
|
</ul>
|
|
110
110
|
</aside>
|
|
111
111
|
<div class="tsd-comment tsd-typography">
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
121
121
|
<aside class="tsd-sources">
|
|
122
122
|
<ul>
|
|
123
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
123
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L666">datatypes.ts:666</a></li>
|
|
124
124
|
</ul>
|
|
125
125
|
</aside>
|
|
126
126
|
<div class="tsd-comment tsd-typography">
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
136
136
|
<aside class="tsd-sources">
|
|
137
137
|
<ul>
|
|
138
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
138
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L656">datatypes.ts:656</a></li>
|
|
139
139
|
</ul>
|
|
140
140
|
</aside>
|
|
141
141
|
<div class="tsd-comment tsd-typography">
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
151
151
|
<aside class="tsd-sources">
|
|
152
152
|
<ul>
|
|
153
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
153
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L652">datatypes.ts:652</a></li>
|
|
154
154
|
</ul>
|
|
155
155
|
</aside>
|
|
156
156
|
<div class="tsd-comment tsd-typography">
|
|
@@ -165,7 +165,7 @@
|
|
|
165
165
|
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
166
166
|
<aside class="tsd-sources">
|
|
167
167
|
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
168
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L658">datatypes.ts:658</a></li>
|
|
169
169
|
</ul>
|
|
170
170
|
</aside>
|
|
171
171
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,7 +180,7 @@
|
|
|
180
180
|
<div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
181
181
|
<aside class="tsd-sources">
|
|
182
182
|
<ul>
|
|
183
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
183
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L662">datatypes.ts:662</a></li>
|
|
184
184
|
</ul>
|
|
185
185
|
</aside>
|
|
186
186
|
<div class="tsd-comment tsd-typography">
|
|
@@ -195,7 +195,7 @@
|
|
|
195
195
|
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
196
196
|
<aside class="tsd-sources">
|
|
197
197
|
<ul>
|
|
198
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
198
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L660">datatypes.ts:660</a></li>
|
|
199
199
|
</ul>
|
|
200
200
|
</aside>
|
|
201
201
|
<div class="tsd-comment tsd-typography">
|
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
211
211
|
<aside class="tsd-sources">
|
|
212
212
|
<ul>
|
|
213
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
213
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L654">datatypes.ts:654</a></li>
|
|
214
214
|
</ul>
|
|
215
215
|
</aside>
|
|
216
216
|
<div class="tsd-comment tsd-typography">
|
|
@@ -225,7 +225,7 @@
|
|
|
225
225
|
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
226
226
|
<aside class="tsd-sources">
|
|
227
227
|
<ul>
|
|
228
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
228
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L668">datatypes.ts:668</a></li>
|
|
229
229
|
</ul>
|
|
230
230
|
</aside>
|
|
231
231
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</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">></span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L468">datatypes.ts:468</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L466">datatypes.ts:466</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L470">datatypes.ts:470</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</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">></span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L477">datatypes.ts:477</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L475">datatypes.ts:475</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L479">datatypes.ts:479</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -111,7 +111,7 @@
|
|
|
111
111
|
<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>
|
|
112
112
|
<aside class="tsd-sources">
|
|
113
113
|
<ul>
|
|
114
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L610">datatypes.ts:610</a></li>
|
|
115
115
|
</ul>
|
|
116
116
|
</aside>
|
|
117
117
|
<div class="tsd-comment tsd-typography">
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
<div class="tsd-signature tsd-kind-icon">assertion<wbr>Consumer<wbr>Service<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
127
127
|
<aside class="tsd-sources">
|
|
128
128
|
<ul>
|
|
129
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
129
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L616">datatypes.ts:616</a></li>
|
|
130
130
|
</ul>
|
|
131
131
|
</aside>
|
|
132
132
|
<div class="tsd-comment tsd-typography">
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
<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>
|
|
142
142
|
<aside class="tsd-sources">
|
|
143
143
|
<ul>
|
|
144
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
144
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L612">datatypes.ts:612</a></li>
|
|
145
145
|
</ul>
|
|
146
146
|
</aside>
|
|
147
147
|
<div class="tsd-comment tsd-typography">
|
|
@@ -156,7 +156,7 @@
|
|
|
156
156
|
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
157
157
|
<aside class="tsd-sources">
|
|
158
158
|
<ul>
|
|
159
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
159
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L600">datatypes.ts:600</a></li>
|
|
160
160
|
</ul>
|
|
161
161
|
</aside>
|
|
162
162
|
<div class="tsd-comment tsd-typography">
|
|
@@ -171,7 +171,7 @@
|
|
|
171
171
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
172
172
|
<aside class="tsd-sources">
|
|
173
173
|
<ul>
|
|
174
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
174
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L596">datatypes.ts:596</a></li>
|
|
175
175
|
</ul>
|
|
176
176
|
</aside>
|
|
177
177
|
<div class="tsd-comment tsd-typography">
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
<div class="tsd-signature tsd-kind-icon">entity<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
187
187
|
<aside class="tsd-sources">
|
|
188
188
|
<ul>
|
|
189
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L614">datatypes.ts:614</a></li>
|
|
190
190
|
</ul>
|
|
191
191
|
</aside>
|
|
192
192
|
<div class="tsd-comment tsd-typography">
|
|
@@ -201,7 +201,7 @@
|
|
|
201
201
|
<div class="tsd-signature tsd-kind-icon">force<wbr>Authn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
202
202
|
<aside class="tsd-sources">
|
|
203
203
|
<ul>
|
|
204
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
204
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L608">datatypes.ts:608</a></li>
|
|
205
205
|
</ul>
|
|
206
206
|
</aside>
|
|
207
207
|
<div class="tsd-comment tsd-typography">
|
|
@@ -216,7 +216,7 @@
|
|
|
216
216
|
<div class="tsd-signature tsd-kind-icon">idp<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
217
217
|
<aside class="tsd-sources">
|
|
218
218
|
<ul>
|
|
219
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
219
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L606">datatypes.ts:606</a></li>
|
|
220
220
|
</ul>
|
|
221
221
|
</aside>
|
|
222
222
|
<div class="tsd-comment tsd-typography">
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
232
232
|
<aside class="tsd-sources">
|
|
233
233
|
<ul>
|
|
234
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
234
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L602">datatypes.ts:602</a></li>
|
|
235
235
|
</ul>
|
|
236
236
|
</aside>
|
|
237
237
|
<div class="tsd-comment tsd-typography">
|
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
247
247
|
<aside class="tsd-sources">
|
|
248
248
|
<ul>
|
|
249
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
249
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L604">datatypes.ts:604</a></li>
|
|
250
250
|
</ul>
|
|
251
251
|
</aside>
|
|
252
252
|
<div class="tsd-comment tsd-typography">
|
|
@@ -261,7 +261,7 @@
|
|
|
261
261
|
<div class="tsd-signature tsd-kind-icon">metadata<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
262
262
|
<aside class="tsd-sources">
|
|
263
263
|
<ul>
|
|
264
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
264
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L622">datatypes.ts:622</a></li>
|
|
265
265
|
</ul>
|
|
266
266
|
</aside>
|
|
267
267
|
<div class="tsd-comment tsd-typography">
|
|
@@ -276,7 +276,7 @@
|
|
|
276
276
|
<div class="tsd-signature tsd-kind-icon">nameid<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
277
277
|
<aside class="tsd-sources">
|
|
278
278
|
<ul>
|
|
279
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
279
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L624">datatypes.ts:624</a></li>
|
|
280
280
|
</ul>
|
|
281
281
|
</aside>
|
|
282
282
|
<div class="tsd-comment tsd-typography">
|
|
@@ -291,7 +291,7 @@
|
|
|
291
291
|
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
292
292
|
<aside class="tsd-sources">
|
|
293
293
|
<ul>
|
|
294
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
294
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L598">datatypes.ts:598</a></li>
|
|
295
295
|
</ul>
|
|
296
296
|
</aside>
|
|
297
297
|
<div class="tsd-comment tsd-typography">
|
|
@@ -306,7 +306,7 @@
|
|
|
306
306
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Signing<wbr>Certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
307
307
|
<aside class="tsd-sources">
|
|
308
308
|
<ul>
|
|
309
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
309
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L620">datatypes.ts:620</a></li>
|
|
310
310
|
</ul>
|
|
311
311
|
</aside>
|
|
312
312
|
<div class="tsd-comment tsd-typography">
|
|
@@ -321,7 +321,7 @@
|
|
|
321
321
|
<div class="tsd-signature tsd-kind-icon">single<wbr>Logout<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
322
322
|
<aside class="tsd-sources">
|
|
323
323
|
<ul>
|
|
324
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
324
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L618">datatypes.ts:618</a></li>
|
|
325
325
|
</ul>
|
|
326
326
|
</aside>
|
|
327
327
|
<div class="tsd-comment tsd-typography">
|
|
@@ -106,7 +106,7 @@
|
|
|
106
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
107
|
<aside class="tsd-sources">
|
|
108
108
|
<ul>
|
|
109
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
109
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L643">datatypes.ts:643</a></li>
|
|
110
110
|
</ul>
|
|
111
111
|
</aside>
|
|
112
112
|
<div class="tsd-comment tsd-typography">
|
|
@@ -121,7 +121,7 @@
|
|
|
121
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
122
|
<aside class="tsd-sources">
|
|
123
123
|
<ul>
|
|
124
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L645">datatypes.ts:645</a></li>
|
|
125
125
|
</ul>
|
|
126
126
|
</aside>
|
|
127
127
|
<div class="tsd-comment tsd-typography">
|
|
@@ -136,7 +136,7 @@
|
|
|
136
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
137
|
<aside class="tsd-sources">
|
|
138
138
|
<ul>
|
|
139
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
139
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L633">datatypes.ts:633</a></li>
|
|
140
140
|
</ul>
|
|
141
141
|
</aside>
|
|
142
142
|
<div class="tsd-comment tsd-typography">
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
152
152
|
<aside class="tsd-sources">
|
|
153
153
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
154
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L629">datatypes.ts:629</a></li>
|
|
155
155
|
</ul>
|
|
156
156
|
</aside>
|
|
157
157
|
<div class="tsd-comment tsd-typography">
|
|
@@ -166,7 +166,7 @@
|
|
|
166
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
167
|
<aside class="tsd-sources">
|
|
168
168
|
<ul>
|
|
169
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
169
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L641">datatypes.ts:641</a></li>
|
|
170
170
|
</ul>
|
|
171
171
|
</aside>
|
|
172
172
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +181,7 @@
|
|
|
181
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
182
|
<aside class="tsd-sources">
|
|
183
183
|
<ul>
|
|
184
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
184
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L639">datatypes.ts:639</a></li>
|
|
185
185
|
</ul>
|
|
186
186
|
</aside>
|
|
187
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -196,7 +196,7 @@
|
|
|
196
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
197
|
<aside class="tsd-sources">
|
|
198
198
|
<ul>
|
|
199
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
199
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L635">datatypes.ts:635</a></li>
|
|
200
200
|
</ul>
|
|
201
201
|
</aside>
|
|
202
202
|
<div class="tsd-comment tsd-typography">
|
|
@@ -211,7 +211,7 @@
|
|
|
211
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
212
|
<aside class="tsd-sources">
|
|
213
213
|
<ul>
|
|
214
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
214
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L637">datatypes.ts:637</a></li>
|
|
215
215
|
</ul>
|
|
216
216
|
</aside>
|
|
217
217
|
<div class="tsd-comment tsd-typography">
|
|
@@ -226,7 +226,7 @@
|
|
|
226
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
227
|
<aside class="tsd-sources">
|
|
228
228
|
<ul>
|
|
229
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
229
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L647">datatypes.ts:647</a></li>
|
|
230
230
|
</ul>
|
|
231
231
|
</aside>
|
|
232
232
|
<div class="tsd-comment tsd-typography">
|
|
@@ -241,7 +241,7 @@
|
|
|
241
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
242
|
<aside class="tsd-sources">
|
|
243
243
|
<ul>
|
|
244
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
244
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L631">datatypes.ts:631</a></li>
|
|
245
245
|
</ul>
|
|
246
246
|
</aside>
|
|
247
247
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L450">datatypes.ts:450</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">min<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L454">datatypes.ts:454</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">terminate<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L452">datatypes.ts:452</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,186 @@
|
|
|
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>EndpointTLSTerminationAtEdge | @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.EndpointTLSTerminationAtEdge.html">EndpointTLSTerminationAtEdge</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointTLSTerminationAtEdge</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">EndpointTLSTerminationAtEdge</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.EndpointTLSTerminationAtEdge.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointTLSTerminationAtEdge.html#minVersion" class="tsd-kind-icon">min<wbr>Version</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="enabled" class="tsd-anchor"></a>
|
|
97
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
|
|
98
|
+
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
99
|
+
<aside class="tsd-sources">
|
|
100
|
+
<ul>
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L459">datatypes.ts:459</a></li>
|
|
102
|
+
</ul>
|
|
103
|
+
</aside>
|
|
104
|
+
<div class="tsd-comment tsd-typography">
|
|
105
|
+
<div class="lead">
|
|
106
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
107
|
+
</div>
|
|
108
|
+
</div>
|
|
109
|
+
</section>
|
|
110
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
111
|
+
<a name="minVersion" class="tsd-anchor"></a>
|
|
112
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr>Version</h3>
|
|
113
|
+
<div class="tsd-signature tsd-kind-icon">min<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
114
|
+
<aside class="tsd-sources">
|
|
115
|
+
<ul>
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L461">datatypes.ts:461</a></li>
|
|
117
|
+
</ul>
|
|
118
|
+
</aside>
|
|
119
|
+
<div class="tsd-comment tsd-typography">
|
|
120
|
+
<div class="lead">
|
|
121
|
+
<p>The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if <code>terminate_at</code> is set to <code>upstream</code>.</p>
|
|
122
|
+
</div>
|
|
123
|
+
</div>
|
|
124
|
+
</section>
|
|
125
|
+
</section>
|
|
126
|
+
</div>
|
|
127
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
128
|
+
<nav class="tsd-navigation primary">
|
|
129
|
+
<ul>
|
|
130
|
+
<li class=" ">
|
|
131
|
+
<a href="../modules.html">Modules</a>
|
|
132
|
+
</li>
|
|
133
|
+
<li class=" tsd-kind-module">
|
|
134
|
+
<a href="../modules/client.html">client</a>
|
|
135
|
+
</li>
|
|
136
|
+
<li class="current tsd-kind-module">
|
|
137
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
138
|
+
</li>
|
|
139
|
+
<li class=" tsd-kind-module">
|
|
140
|
+
<a href="../modules/services.html">services</a>
|
|
141
|
+
</li>
|
|
142
|
+
</ul>
|
|
143
|
+
</nav>
|
|
144
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
145
|
+
<ul class="before-current">
|
|
146
|
+
</ul>
|
|
147
|
+
<ul class="current">
|
|
148
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
149
|
+
<a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>AtEdge</a>
|
|
150
|
+
<ul>
|
|
151
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
152
|
+
<a href="datatypes.EndpointTLSTerminationAtEdge.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
153
|
+
</li>
|
|
154
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
155
|
+
<a href="datatypes.EndpointTLSTerminationAtEdge.html#minVersion" class="tsd-kind-icon">min<wbr>Version</a>
|
|
156
|
+
</li>
|
|
157
|
+
</ul>
|
|
158
|
+
</li>
|
|
159
|
+
</ul>
|
|
160
|
+
<ul class="after-current">
|
|
161
|
+
</ul>
|
|
162
|
+
</nav>
|
|
163
|
+
</div>
|
|
164
|
+
</div>
|
|
165
|
+
</div>
|
|
166
|
+
<footer class="with-border-bottom">
|
|
167
|
+
<div class="container">
|
|
168
|
+
<h2>Legend</h2>
|
|
169
|
+
<div class="tsd-legend-group">
|
|
170
|
+
<ul class="tsd-legend">
|
|
171
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
172
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
173
|
+
</ul>
|
|
174
|
+
<ul class="tsd-legend">
|
|
175
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
176
|
+
</ul>
|
|
177
|
+
</div>
|
|
178
|
+
</div>
|
|
179
|
+
</footer>
|
|
180
|
+
<div class="container tsd-generator">
|
|
181
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
182
|
+
</div>
|
|
183
|
+
<div class="overlay"></div>
|
|
184
|
+
<script src="../assets/js/main.js"></script>
|
|
185
|
+
</body>
|
|
186
|
+
</html>
|