@ngrok/ngrok-api 0.2.0 → 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.
- package/docs/CNAME +1 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +37 -43
- package/docs/classes/services.APIKeys.html +9 -9
- package/docs/classes/services.AbuseReports.html +6 -6
- package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +61 -69
- package/docs/classes/services.CertificateAuthorities.html +9 -9
- package/docs/classes/services.Credentials.html +9 -9
- package/docs/classes/services.EndpointCircuitBreakerModule.html +7 -7
- package/docs/classes/services.EndpointCompressionModule.html +7 -7
- package/docs/classes/services.EndpointConfigurations.html +9 -9
- package/docs/classes/services.EndpointIPPolicyModule.html +7 -7
- package/docs/classes/services.EndpointLoggingModule.html +7 -7
- package/docs/classes/services.EndpointMutualTLSModule.html +7 -7
- package/docs/classes/services.EndpointOAuthModule.html +7 -7
- package/docs/classes/services.EndpointOIDCModule.html +7 -7
- package/docs/classes/services.EndpointRequestHeadersModule.html +7 -7
- package/docs/classes/services.EndpointResponseHeadersModule.html +7 -7
- package/docs/classes/services.EndpointSAMLModule.html +7 -7
- package/docs/classes/services.EndpointTLSTerminationModule.html +7 -7
- package/docs/classes/services.EndpointWebhookValidationModule.html +7 -7
- package/docs/classes/services.EventDestinations.html +9 -9
- package/docs/classes/services.EventSources.html +9 -9
- package/docs/classes/services.EventStreams.html +9 -9
- package/docs/classes/services.EventSubscriptions.html +9 -9
- package/docs/classes/services.IPPolicies.html +9 -9
- package/docs/classes/services.IPPolicyRules.html +9 -9
- package/docs/classes/services.IPRestrictions.html +9 -9
- package/docs/classes/services.ReservedAddrs.html +10 -10
- package/docs/classes/services.ReservedDomains.html +13 -13
- package/docs/classes/services.SSHCertificateAuthorities.html +9 -9
- package/docs/classes/services.SSHCredentials.html +9 -9
- package/docs/classes/services.SSHHostCertificates.html +9 -9
- package/docs/classes/services.SSHUserCertificates.html +9 -9
- package/docs/classes/services.TLSCertificates.html +9 -9
- package/docs/classes/services.TunnelSessions.html +9 -9
- package/docs/classes/services.Tunnels.html +5 -5
- 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.IPWhitelistEntry.html → datatypes.AgentIngress.html} +73 -35
- package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.AgentIngressCreate.html} +20 -20
- package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.AgentIngressList.html} +26 -26
- package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
- 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.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCompressionReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointConfiguration.html +18 -18
- package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +15 -15
- package/docs/interfaces/datatypes.EndpointConfigurationList.html +3 -3
- package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +15 -15
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointLogging.html +2 -2
- package/docs/interfaces/datatypes.EndpointLoggingMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSReplace.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.EndpointOAuthReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointOIDCReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
- package/docs/interfaces/datatypes.EndpointSAMLReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +2 -2
- 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.EventStream.html +9 -9
- package/docs/interfaces/datatypes.EventStreamCreate.html +6 -6
- package/docs/interfaces/datatypes.EventStreamList.html +3 -3
- package/docs/interfaces/datatypes.EventStreamUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- 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.IPPolicy.html +6 -6
- package/docs/interfaces/datatypes.IPPolicyCreate.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +4 -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 +8 -8
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomain.html +32 -13
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +8 -8
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +7 -7
- 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.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.Tunnel.html +7 -7
- 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/modules/datatypes.html +16 -20
- package/docs/modules/services.html +4 -4
- package/lib/client.d.ts +1 -5
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +3 -4
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +49 -47
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +27 -31
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +155 -159
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +3 -7
- package/src/datatypes.ts +53 -52
- package/src/services.ts +98 -102
- package/docs/interfaces/datatypes.ReservedDomainCertNSTarget.html +0 -186
|
@@ -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 datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L416">datatypes.ts:416</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 datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L414">datatypes.ts:414</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 datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L418">datatypes.ts:418</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1043">datatypes.ts:1043</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in datatypes.ts:
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1044">datatypes.ts:1044</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -94,6 +94,7 @@
|
|
|
94
94
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
|
|
95
95
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
|
|
96
96
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#metadataUrl" class="tsd-kind-icon">metadata<wbr>Url</a></li>
|
|
97
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a></li>
|
|
97
98
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
|
|
98
99
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#requestSigningCertificatePem" class="tsd-kind-icon">request<wbr>Signing<wbr>Certificate<wbr>Pem</a></li>
|
|
99
100
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointSAML.html#singleLogoutUrl" class="tsd-kind-icon">single<wbr>Logout<wbr>Url</a></li>
|
|
@@ -110,7 +111,7 @@
|
|
|
110
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>
|
|
111
112
|
<aside class="tsd-sources">
|
|
112
113
|
<ul>
|
|
113
|
-
<li>Defined in datatypes.ts:
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L549">datatypes.ts:549</a></li>
|
|
114
115
|
</ul>
|
|
115
116
|
</aside>
|
|
116
117
|
<div class="tsd-comment tsd-typography">
|
|
@@ -125,7 +126,7 @@
|
|
|
125
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>
|
|
126
127
|
<aside class="tsd-sources">
|
|
127
128
|
<ul>
|
|
128
|
-
<li>Defined in datatypes.ts:
|
|
129
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L555">datatypes.ts:555</a></li>
|
|
129
130
|
</ul>
|
|
130
131
|
</aside>
|
|
131
132
|
<div class="tsd-comment tsd-typography">
|
|
@@ -140,7 +141,7 @@
|
|
|
140
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>
|
|
141
142
|
<aside class="tsd-sources">
|
|
142
143
|
<ul>
|
|
143
|
-
<li>Defined in datatypes.ts:
|
|
144
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L551">datatypes.ts:551</a></li>
|
|
144
145
|
</ul>
|
|
145
146
|
</aside>
|
|
146
147
|
<div class="tsd-comment tsd-typography">
|
|
@@ -155,7 +156,7 @@
|
|
|
155
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>
|
|
156
157
|
<aside class="tsd-sources">
|
|
157
158
|
<ul>
|
|
158
|
-
<li>Defined in datatypes.ts:
|
|
159
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L539">datatypes.ts:539</a></li>
|
|
159
160
|
</ul>
|
|
160
161
|
</aside>
|
|
161
162
|
<div class="tsd-comment tsd-typography">
|
|
@@ -170,7 +171,7 @@
|
|
|
170
171
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
171
172
|
<aside class="tsd-sources">
|
|
172
173
|
<ul>
|
|
173
|
-
<li>Defined in datatypes.ts:
|
|
174
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L535">datatypes.ts:535</a></li>
|
|
174
175
|
</ul>
|
|
175
176
|
</aside>
|
|
176
177
|
<div class="tsd-comment tsd-typography">
|
|
@@ -185,7 +186,7 @@
|
|
|
185
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>
|
|
186
187
|
<aside class="tsd-sources">
|
|
187
188
|
<ul>
|
|
188
|
-
<li>Defined in datatypes.ts:
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L553">datatypes.ts:553</a></li>
|
|
189
190
|
</ul>
|
|
190
191
|
</aside>
|
|
191
192
|
<div class="tsd-comment tsd-typography">
|
|
@@ -200,7 +201,7 @@
|
|
|
200
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>
|
|
201
202
|
<aside class="tsd-sources">
|
|
202
203
|
<ul>
|
|
203
|
-
<li>Defined in datatypes.ts:
|
|
204
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L547">datatypes.ts:547</a></li>
|
|
204
205
|
</ul>
|
|
205
206
|
</aside>
|
|
206
207
|
<div class="tsd-comment tsd-typography">
|
|
@@ -215,7 +216,7 @@
|
|
|
215
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>
|
|
216
217
|
<aside class="tsd-sources">
|
|
217
218
|
<ul>
|
|
218
|
-
<li>Defined in datatypes.ts:
|
|
219
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L545">datatypes.ts:545</a></li>
|
|
219
220
|
</ul>
|
|
220
221
|
</aside>
|
|
221
222
|
<div class="tsd-comment tsd-typography">
|
|
@@ -230,7 +231,7 @@
|
|
|
230
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>
|
|
231
232
|
<aside class="tsd-sources">
|
|
232
233
|
<ul>
|
|
233
|
-
<li>Defined in datatypes.ts:
|
|
234
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L541">datatypes.ts:541</a></li>
|
|
234
235
|
</ul>
|
|
235
236
|
</aside>
|
|
236
237
|
<div class="tsd-comment tsd-typography">
|
|
@@ -245,7 +246,7 @@
|
|
|
245
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>
|
|
246
247
|
<aside class="tsd-sources">
|
|
247
248
|
<ul>
|
|
248
|
-
<li>Defined in datatypes.ts:
|
|
249
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L543">datatypes.ts:543</a></li>
|
|
249
250
|
</ul>
|
|
250
251
|
</aside>
|
|
251
252
|
<div class="tsd-comment tsd-typography">
|
|
@@ -260,7 +261,7 @@
|
|
|
260
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>
|
|
261
262
|
<aside class="tsd-sources">
|
|
262
263
|
<ul>
|
|
263
|
-
<li>Defined in datatypes.ts:
|
|
264
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L561">datatypes.ts:561</a></li>
|
|
264
265
|
</ul>
|
|
265
266
|
</aside>
|
|
266
267
|
<div class="tsd-comment tsd-typography">
|
|
@@ -269,13 +270,28 @@
|
|
|
269
270
|
</div>
|
|
270
271
|
</div>
|
|
271
272
|
</section>
|
|
273
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
274
|
+
<a name="nameidFormat" class="tsd-anchor"></a>
|
|
275
|
+
<h3>nameid<wbr>Format</h3>
|
|
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
|
+
<aside class="tsd-sources">
|
|
278
|
+
<ul>
|
|
279
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L563">datatypes.ts:563</a></li>
|
|
280
|
+
</ul>
|
|
281
|
+
</aside>
|
|
282
|
+
<div class="tsd-comment tsd-typography">
|
|
283
|
+
<div class="lead">
|
|
284
|
+
<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>
|
|
285
|
+
</div>
|
|
286
|
+
</div>
|
|
287
|
+
</section>
|
|
272
288
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
273
289
|
<a name="optionsPassthrough" class="tsd-anchor"></a>
|
|
274
290
|
<h3>options<wbr>Passthrough</h3>
|
|
275
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>
|
|
276
292
|
<aside class="tsd-sources">
|
|
277
293
|
<ul>
|
|
278
|
-
<li>Defined in datatypes.ts:
|
|
294
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L537">datatypes.ts:537</a></li>
|
|
279
295
|
</ul>
|
|
280
296
|
</aside>
|
|
281
297
|
<div class="tsd-comment tsd-typography">
|
|
@@ -290,7 +306,7 @@
|
|
|
290
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>
|
|
291
307
|
<aside class="tsd-sources">
|
|
292
308
|
<ul>
|
|
293
|
-
<li>Defined in datatypes.ts:
|
|
309
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L559">datatypes.ts:559</a></li>
|
|
294
310
|
</ul>
|
|
295
311
|
</aside>
|
|
296
312
|
<div class="tsd-comment tsd-typography">
|
|
@@ -305,7 +321,7 @@
|
|
|
305
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>
|
|
306
322
|
<aside class="tsd-sources">
|
|
307
323
|
<ul>
|
|
308
|
-
<li>Defined in datatypes.ts:
|
|
324
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L557">datatypes.ts:557</a></li>
|
|
309
325
|
</ul>
|
|
310
326
|
</aside>
|
|
311
327
|
<div class="tsd-comment tsd-typography">
|
|
@@ -373,6 +389,9 @@
|
|
|
373
389
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
374
390
|
<a href="datatypes.EndpointSAML.html#metadataUrl" class="tsd-kind-icon">metadata<wbr>Url</a>
|
|
375
391
|
</li>
|
|
392
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
393
|
+
<a href="datatypes.EndpointSAML.html#nameidFormat" class="tsd-kind-icon">nameid<wbr>Format</a>
|
|
394
|
+
</li>
|
|
376
395
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
377
396
|
<a href="datatypes.EndpointSAML.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
|
|
378
397
|
</li>
|
|
@@ -91,6 +91,7 @@
|
|
|
91
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
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
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>
|
|
94
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>
|
|
95
96
|
</ul>
|
|
96
97
|
</section>
|
|
@@ -105,7 +106,7 @@
|
|
|
105
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>
|
|
106
107
|
<aside class="tsd-sources">
|
|
107
108
|
<ul>
|
|
108
|
-
<li>Defined in datatypes.ts:
|
|
109
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L582">datatypes.ts:582</a></li>
|
|
109
110
|
</ul>
|
|
110
111
|
</aside>
|
|
111
112
|
<div class="tsd-comment tsd-typography">
|
|
@@ -120,7 +121,7 @@
|
|
|
120
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>
|
|
121
122
|
<aside class="tsd-sources">
|
|
122
123
|
<ul>
|
|
123
|
-
<li>Defined in datatypes.ts:
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L584">datatypes.ts:584</a></li>
|
|
124
125
|
</ul>
|
|
125
126
|
</aside>
|
|
126
127
|
<div class="tsd-comment tsd-typography">
|
|
@@ -135,7 +136,7 @@
|
|
|
135
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>
|
|
136
137
|
<aside class="tsd-sources">
|
|
137
138
|
<ul>
|
|
138
|
-
<li>Defined in datatypes.ts:
|
|
139
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L572">datatypes.ts:572</a></li>
|
|
139
140
|
</ul>
|
|
140
141
|
</aside>
|
|
141
142
|
<div class="tsd-comment tsd-typography">
|
|
@@ -150,7 +151,7 @@
|
|
|
150
151
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
151
152
|
<aside class="tsd-sources">
|
|
152
153
|
<ul>
|
|
153
|
-
<li>Defined in datatypes.ts:
|
|
154
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L568">datatypes.ts:568</a></li>
|
|
154
155
|
</ul>
|
|
155
156
|
</aside>
|
|
156
157
|
<div class="tsd-comment tsd-typography">
|
|
@@ -165,7 +166,7 @@
|
|
|
165
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>
|
|
166
167
|
<aside class="tsd-sources">
|
|
167
168
|
<ul>
|
|
168
|
-
<li>Defined in datatypes.ts:
|
|
169
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L580">datatypes.ts:580</a></li>
|
|
169
170
|
</ul>
|
|
170
171
|
</aside>
|
|
171
172
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,7 +181,7 @@
|
|
|
180
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>
|
|
181
182
|
<aside class="tsd-sources">
|
|
182
183
|
<ul>
|
|
183
|
-
<li>Defined in datatypes.ts:
|
|
184
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L578">datatypes.ts:578</a></li>
|
|
184
185
|
</ul>
|
|
185
186
|
</aside>
|
|
186
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -195,7 +196,7 @@
|
|
|
195
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>
|
|
196
197
|
<aside class="tsd-sources">
|
|
197
198
|
<ul>
|
|
198
|
-
<li>Defined in datatypes.ts:
|
|
199
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L574">datatypes.ts:574</a></li>
|
|
199
200
|
</ul>
|
|
200
201
|
</aside>
|
|
201
202
|
<div class="tsd-comment tsd-typography">
|
|
@@ -210,7 +211,7 @@
|
|
|
210
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>
|
|
211
212
|
<aside class="tsd-sources">
|
|
212
213
|
<ul>
|
|
213
|
-
<li>Defined in datatypes.ts:
|
|
214
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L576">datatypes.ts:576</a></li>
|
|
214
215
|
</ul>
|
|
215
216
|
</aside>
|
|
216
217
|
<div class="tsd-comment tsd-typography">
|
|
@@ -219,13 +220,28 @@
|
|
|
219
220
|
</div>
|
|
220
221
|
</div>
|
|
221
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>
|
|
222
238
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
223
239
|
<a name="optionsPassthrough" class="tsd-anchor"></a>
|
|
224
240
|
<h3>options<wbr>Passthrough</h3>
|
|
225
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>
|
|
226
242
|
<aside class="tsd-sources">
|
|
227
243
|
<ul>
|
|
228
|
-
<li>Defined in datatypes.ts:
|
|
244
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L570">datatypes.ts:570</a></li>
|
|
229
245
|
</ul>
|
|
230
246
|
</aside>
|
|
231
247
|
<div class="tsd-comment tsd-typography">
|
|
@@ -284,6 +300,9 @@
|
|
|
284
300
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
285
301
|
<a href="datatypes.EndpointSAMLMutate.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
|
|
286
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>
|
|
287
306
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
288
307
|
<a href="datatypes.EndpointSAMLMutate.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
|
|
289
308
|
</li>
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
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
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
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
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in datatypes.ts:
|
|
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
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -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 datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L382">datatypes.ts:382</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 datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L386">datatypes.ts:386</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 datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L384">datatypes.ts:384</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1023">datatypes.ts:1023</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in datatypes.ts:
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1024">datatypes.ts:1024</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -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 datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L354">datatypes.ts:354</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,12 +114,12 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">provider<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 datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L356">datatypes.ts:356</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
121
121
|
<div class="lead">
|
|
122
|
-
<p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: <code>SLACK</code>, <code>SNS</code>, <code>STRIPE</code>, <code>GITHUB</code>, <code>TWILIO</code>, <code>SHOPIFY</code>, <code>GITLAB</code>, <code>INTERCOM</code>.</p>
|
|
122
|
+
<p>a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: <code>SLACK</code>, <code>SNS</code>, <code>STRIPE</code>, <code>GITHUB</code>, <code>TWILIO</code>, <code>SHOPIFY</code>, <code>GITLAB</code>, <code>INTERCOM</code>, <code>SENDGRID</code>, <code>XERO</code>.</p>
|
|
123
123
|
</div>
|
|
124
124
|
</div>
|
|
125
125
|
</section>
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">secret<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 datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L358">datatypes.ts:358</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1053">datatypes.ts:1053</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in datatypes.ts:
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L1054">datatypes.ts:1054</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
<div class="tsd-signature tsd-kind-icon">details<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>
|
|
101
101
|
<aside class="tsd-sources">
|
|
102
102
|
<ul>
|
|
103
|
-
<li>Defined in datatypes.ts:17</li>
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L17">datatypes.ts:17</a></li>
|
|
104
104
|
</ul>
|
|
105
105
|
</aside>
|
|
106
106
|
</section>
|
|
@@ -110,7 +110,7 @@
|
|
|
110
110
|
<div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
111
111
|
<aside class="tsd-sources">
|
|
112
112
|
<ul>
|
|
113
|
-
<li>Defined in datatypes.ts:14</li>
|
|
113
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L14">datatypes.ts:14</a></li>
|
|
114
114
|
</ul>
|
|
115
115
|
</aside>
|
|
116
116
|
</section>
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
<div class="tsd-signature tsd-kind-icon">msg<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 datatypes.ts:16</li>
|
|
123
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L16">datatypes.ts:16</a></li>
|
|
124
124
|
</ul>
|
|
125
125
|
</aside>
|
|
126
126
|
</section>
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
131
131
|
<aside class="tsd-sources">
|
|
132
132
|
<ul>
|
|
133
|
-
<li>Defined in datatypes.ts:15</li>
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L15">datatypes.ts:15</a></li>
|
|
134
134
|
</ul>
|
|
135
135
|
</aside>
|
|
136
136
|
</section>
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in datatypes.ts:
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L700">datatypes.ts:700</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in datatypes.ts:
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L702">datatypes.ts:702</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in datatypes.ts:
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L704">datatypes.ts:704</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in datatypes.ts:
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L696">datatypes.ts:696</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in datatypes.ts:
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L698">datatypes.ts:698</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTarget</a></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in datatypes.ts:
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L706">datatypes.ts:706</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in datatypes.ts:
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L708">datatypes.ts:708</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
101
101
|
<aside class="tsd-sources">
|
|
102
102
|
<ul>
|
|
103
|
-
<li>Defined in datatypes.ts:
|
|
103
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L674">datatypes.ts:674</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">format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
116
116
|
<aside class="tsd-sources">
|
|
117
117
|
<ul>
|
|
118
|
-
<li>Defined in datatypes.ts:
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L676">datatypes.ts:676</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">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
131
131
|
<aside class="tsd-sources">
|
|
132
132
|
<ul>
|
|
133
|
-
<li>Defined in datatypes.ts:
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L672">datatypes.ts:672</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">target<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">EventTarget</a></div>
|
|
146
146
|
<aside class="tsd-sources">
|
|
147
147
|
<ul>
|
|
148
|
-
<li>Defined in datatypes.ts:
|
|
148
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L678">datatypes.ts:678</a></li>
|
|
149
149
|
</ul>
|
|
150
150
|
</aside>
|
|
151
151
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">event<wbr>Destinations<span class="tsd-signature-symbol">:</span> <a href="datatypes.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L713">datatypes.ts:713</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">next<wbr>Page<wbr>Uri<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 datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L717">datatypes.ts:717</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">uri<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 datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L715">datatypes.ts:715</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|