@ngrok/ngrok-api 0.17.0 → 0.18.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/CHANGELOG.md +6 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +44 -30
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +6 -6
- package/docs/classes/services.CertificateAuthorities.html +7 -7
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +6 -6
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +7 -7
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +7 -7
- package/docs/classes/services.SSHUserCertificates.html +7 -7
- package/docs/classes/services.Secrets.html +6 -6
- package/docs/classes/services.ServiceUsers.html +352 -0
- package/docs/classes/services.StaticBackends.html +6 -6
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.Vaults.html +7 -7
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- 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 +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +5 -5
- package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
- package/docs/interfaces/datatypes.BotUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
- package/docs/interfaces/datatypes.BrowserSession.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 +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +28 -28
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCreate.html +8 -8
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointListArgs.html +18 -4
- 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.EndpointOAuthAmazon.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- 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 +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointUpdate.html +8 -8
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- 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 +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +5 -5
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +6 -6
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.FilteredPaging.html +190 -0
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- 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.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.ItemPaging.html +3 -3
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
- 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 -6
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- 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 +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- 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.Secret.html +29 -10
- package/docs/interfaces/datatypes.SecretCreate.html +24 -5
- package/docs/interfaces/datatypes.SecretList.html +3 -3
- package/docs/interfaces/datatypes.SecretUpdate.html +5 -5
- package/docs/interfaces/datatypes.ServiceUser.html +243 -0
- package/docs/interfaces/datatypes.ServiceUserCreate.html +186 -0
- package/docs/interfaces/datatypes.ServiceUserList.html +205 -0
- package/docs/interfaces/datatypes.ServiceUserUpdate.html +200 -0
- package/docs/interfaces/datatypes.StaticBackend.html +7 -7
- package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
- package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
- package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
- package/docs/interfaces/datatypes.TCPEdge.html +9 -9
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
- 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 +11 -11
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- 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.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.Vault.html +9 -9
- package/docs/interfaces/datatypes.VaultCreate.html +3 -3
- package/docs/interfaces/datatypes.VaultList.html +3 -3
- package/docs/interfaces/datatypes.VaultUpdate.html +4 -4
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +20 -0
- package/docs/modules/services.html +4 -0
- package/lib/client.d.ts +1 -0
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +2 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +46 -3
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +31 -4
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +137 -36
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +3 -1
- package/src/datatypes.ts +51 -3
- package/src/services.ts +151 -38
|
@@ -93,6 +93,7 @@
|
|
|
93
93
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
|
|
94
94
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
95
95
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#vault" class="tsd-kind-icon">vault</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#vaultName" class="tsd-kind-icon">vault<wbr>Name</a></li>
|
|
96
97
|
</ul>
|
|
97
98
|
</section>
|
|
98
99
|
</div>
|
|
@@ -106,7 +107,7 @@
|
|
|
106
107
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
107
108
|
<aside class="tsd-sources">
|
|
108
109
|
<ul>
|
|
109
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
110
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2085">datatypes.ts:2085</a></li>
|
|
110
111
|
</ul>
|
|
111
112
|
</aside>
|
|
112
113
|
<div class="tsd-comment tsd-typography">
|
|
@@ -121,7 +122,7 @@
|
|
|
121
122
|
<div class="tsd-signature tsd-kind-icon">created<wbr>By<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
122
123
|
<aside class="tsd-sources">
|
|
123
124
|
<ul>
|
|
124
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2095">datatypes.ts:2095</a></li>
|
|
125
126
|
</ul>
|
|
126
127
|
</aside>
|
|
127
128
|
<div class="tsd-comment tsd-typography">
|
|
@@ -136,7 +137,7 @@
|
|
|
136
137
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
137
138
|
<aside class="tsd-sources">
|
|
138
139
|
<ul>
|
|
139
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
140
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2091">datatypes.ts:2091</a></li>
|
|
140
141
|
</ul>
|
|
141
142
|
</aside>
|
|
142
143
|
<div class="tsd-comment tsd-typography">
|
|
@@ -151,7 +152,7 @@
|
|
|
151
152
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
152
153
|
<aside class="tsd-sources">
|
|
153
154
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
155
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2081">datatypes.ts:2081</a></li>
|
|
155
156
|
</ul>
|
|
156
157
|
</aside>
|
|
157
158
|
<div class="tsd-comment tsd-typography">
|
|
@@ -166,7 +167,7 @@
|
|
|
166
167
|
<div class="tsd-signature tsd-kind-icon">last<wbr>Updated<wbr>By<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
167
168
|
<aside class="tsd-sources">
|
|
168
169
|
<ul>
|
|
169
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
170
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2097">datatypes.ts:2097</a></li>
|
|
170
171
|
</ul>
|
|
171
172
|
</aside>
|
|
172
173
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +182,7 @@
|
|
|
181
182
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
182
183
|
<aside class="tsd-sources">
|
|
183
184
|
<ul>
|
|
184
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
185
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2093">datatypes.ts:2093</a></li>
|
|
185
186
|
</ul>
|
|
186
187
|
</aside>
|
|
187
188
|
<div class="tsd-comment tsd-typography">
|
|
@@ -196,7 +197,7 @@
|
|
|
196
197
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
197
198
|
<aside class="tsd-sources">
|
|
198
199
|
<ul>
|
|
199
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
200
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2089">datatypes.ts:2089</a></li>
|
|
200
201
|
</ul>
|
|
201
202
|
</aside>
|
|
202
203
|
<div class="tsd-comment tsd-typography">
|
|
@@ -211,7 +212,7 @@
|
|
|
211
212
|
<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
212
213
|
<aside class="tsd-sources">
|
|
213
214
|
<ul>
|
|
214
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
215
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2087">datatypes.ts:2087</a></li>
|
|
215
216
|
</ul>
|
|
216
217
|
</aside>
|
|
217
218
|
<div class="tsd-comment tsd-typography">
|
|
@@ -226,7 +227,7 @@
|
|
|
226
227
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
227
228
|
<aside class="tsd-sources">
|
|
228
229
|
<ul>
|
|
229
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
230
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2083">datatypes.ts:2083</a></li>
|
|
230
231
|
</ul>
|
|
231
232
|
</aside>
|
|
232
233
|
<div class="tsd-comment tsd-typography">
|
|
@@ -241,7 +242,7 @@
|
|
|
241
242
|
<div class="tsd-signature tsd-kind-icon">vault<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
242
243
|
<aside class="tsd-sources">
|
|
243
244
|
<ul>
|
|
244
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
245
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2099">datatypes.ts:2099</a></li>
|
|
245
246
|
</ul>
|
|
246
247
|
</aside>
|
|
247
248
|
<div class="tsd-comment tsd-typography">
|
|
@@ -250,6 +251,21 @@
|
|
|
250
251
|
</div>
|
|
251
252
|
</div>
|
|
252
253
|
</section>
|
|
254
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
255
|
+
<a name="vaultName" class="tsd-anchor"></a>
|
|
256
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> vault<wbr>Name</h3>
|
|
257
|
+
<div class="tsd-signature tsd-kind-icon">vault<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
258
|
+
<aside class="tsd-sources">
|
|
259
|
+
<ul>
|
|
260
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2101">datatypes.ts:2101</a></li>
|
|
261
|
+
</ul>
|
|
262
|
+
</aside>
|
|
263
|
+
<div class="tsd-comment tsd-typography">
|
|
264
|
+
<div class="lead">
|
|
265
|
+
<p>Name of the vault the secret is stored in</p>
|
|
266
|
+
</div>
|
|
267
|
+
</div>
|
|
268
|
+
</section>
|
|
253
269
|
</section>
|
|
254
270
|
</div>
|
|
255
271
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
@@ -306,6 +322,9 @@
|
|
|
306
322
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
307
323
|
<a href="datatypes.Secret.html#vault" class="tsd-kind-icon">vault</a>
|
|
308
324
|
</li>
|
|
325
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
326
|
+
<a href="datatypes.Secret.html#vaultName" class="tsd-kind-icon">vault<wbr>Name</a>
|
|
327
|
+
</li>
|
|
309
328
|
</ul>
|
|
310
329
|
</li>
|
|
311
330
|
</ul>
|
|
@@ -88,6 +88,7 @@
|
|
|
88
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#name" class="tsd-kind-icon">name</a></li>
|
|
89
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#value" class="tsd-kind-icon">value</a></li>
|
|
90
90
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#vaultId" class="tsd-kind-icon">vault<wbr>Id</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#vaultName" class="tsd-kind-icon">vault<wbr>Name</a></li>
|
|
91
92
|
</ul>
|
|
92
93
|
</section>
|
|
93
94
|
</div>
|
|
@@ -101,7 +102,7 @@
|
|
|
101
102
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
103
|
<aside class="tsd-sources">
|
|
103
104
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2059">datatypes.ts:2059</a></li>
|
|
105
106
|
</ul>
|
|
106
107
|
</aside>
|
|
107
108
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +117,7 @@
|
|
|
116
117
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
117
118
|
<aside class="tsd-sources">
|
|
118
119
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2057">datatypes.ts:2057</a></li>
|
|
120
121
|
</ul>
|
|
121
122
|
</aside>
|
|
122
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -131,7 +132,7 @@
|
|
|
131
132
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
132
133
|
<aside class="tsd-sources">
|
|
133
134
|
<ul>
|
|
134
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2053">datatypes.ts:2053</a></li>
|
|
135
136
|
</ul>
|
|
136
137
|
</aside>
|
|
137
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -146,7 +147,7 @@
|
|
|
146
147
|
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
148
|
<aside class="tsd-sources">
|
|
148
149
|
<ul>
|
|
149
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2055">datatypes.ts:2055</a></li>
|
|
150
151
|
</ul>
|
|
151
152
|
</aside>
|
|
152
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,7 +162,7 @@
|
|
|
161
162
|
<div class="tsd-signature tsd-kind-icon">vault<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
162
163
|
<aside class="tsd-sources">
|
|
163
164
|
<ul>
|
|
164
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
165
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2061">datatypes.ts:2061</a></li>
|
|
165
166
|
</ul>
|
|
166
167
|
</aside>
|
|
167
168
|
<div class="tsd-comment tsd-typography">
|
|
@@ -170,6 +171,21 @@
|
|
|
170
171
|
</div>
|
|
171
172
|
</div>
|
|
172
173
|
</section>
|
|
174
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
175
|
+
<a name="vaultName" class="tsd-anchor"></a>
|
|
176
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> vault<wbr>Name</h3>
|
|
177
|
+
<div class="tsd-signature tsd-kind-icon">vault<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
178
|
+
<aside class="tsd-sources">
|
|
179
|
+
<ul>
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2063">datatypes.ts:2063</a></li>
|
|
181
|
+
</ul>
|
|
182
|
+
</aside>
|
|
183
|
+
<div class="tsd-comment tsd-typography">
|
|
184
|
+
<div class="lead">
|
|
185
|
+
<p>name of the referenced vault</p>
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
</section>
|
|
173
189
|
</section>
|
|
174
190
|
</div>
|
|
175
191
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
@@ -211,6 +227,9 @@
|
|
|
211
227
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
212
228
|
<a href="datatypes.SecretCreate.html#vaultId" class="tsd-kind-icon">vault<wbr>Id</a>
|
|
213
229
|
</li>
|
|
230
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
231
|
+
<a href="datatypes.SecretCreate.html#vaultName" class="tsd-kind-icon">vault<wbr>Name</a>
|
|
232
|
+
</li>
|
|
214
233
|
</ul>
|
|
215
234
|
</li>
|
|
216
235
|
</ul>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
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/38e5bd2/src/datatypes.ts#L2109">datatypes.ts:2109</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">secrets<span class="tsd-signature-symbol">:</span> <a href="datatypes.Secret.html" class="tsd-signature-type" data-tsd-kind="Interface">Secret</a><span class="tsd-signature-symbol">[]</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/38e5bd2/src/datatypes.ts#L2106">datatypes.ts:2106</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 <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2107">datatypes.ts:2107</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
</section>
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2076">datatypes.ts:2076</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2068">datatypes.ts:2068</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
132
132
|
<aside class="tsd-sources">
|
|
133
133
|
<ul>
|
|
134
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2074">datatypes.ts:2074</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
147
|
<aside class="tsd-sources">
|
|
148
148
|
<ul>
|
|
149
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2070">datatypes.ts:2070</a></li>
|
|
150
150
|
</ul>
|
|
151
151
|
</aside>
|
|
152
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
162
162
|
<aside class="tsd-sources">
|
|
163
163
|
<ul>
|
|
164
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
164
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2072">datatypes.ts:2072</a></li>
|
|
165
165
|
</ul>
|
|
166
166
|
</aside>
|
|
167
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,243 @@
|
|
|
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>ServiceUser | @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.ServiceUser.html">ServiceUser</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface ServiceUser</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">ServiceUser</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.ServiceUser.html#active" class="tsd-kind-icon">active</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUser.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUser.html#id" class="tsd-kind-icon">id</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUser.html#name" class="tsd-kind-icon">name</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ServiceUser.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
91
|
+
</ul>
|
|
92
|
+
</section>
|
|
93
|
+
</div>
|
|
94
|
+
</section>
|
|
95
|
+
</section>
|
|
96
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
97
|
+
<h2>Properties</h2>
|
|
98
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
|
+
<a name="active" class="tsd-anchor"></a>
|
|
100
|
+
<h3>active</h3>
|
|
101
|
+
<div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
102
|
+
<aside class="tsd-sources">
|
|
103
|
+
<ul>
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2120">datatypes.ts:2120</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</aside>
|
|
107
|
+
<div class="tsd-comment tsd-typography">
|
|
108
|
+
<div class="lead">
|
|
109
|
+
<p>whether or not the service is active</p>
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
</section>
|
|
113
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
114
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
115
|
+
<h3>created<wbr>At</h3>
|
|
116
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
117
|
+
<aside class="tsd-sources">
|
|
118
|
+
<ul>
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2122">datatypes.ts:2122</a></li>
|
|
120
|
+
</ul>
|
|
121
|
+
</aside>
|
|
122
|
+
<div class="tsd-comment tsd-typography">
|
|
123
|
+
<div class="lead">
|
|
124
|
+
<p>timestamp when the api key was created, RFC 3339 format</p>
|
|
125
|
+
</div>
|
|
126
|
+
</div>
|
|
127
|
+
</section>
|
|
128
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
129
|
+
<a name="id" class="tsd-anchor"></a>
|
|
130
|
+
<h3>id</h3>
|
|
131
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
132
|
+
<aside class="tsd-sources">
|
|
133
|
+
<ul>
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2114">datatypes.ts:2114</a></li>
|
|
135
|
+
</ul>
|
|
136
|
+
</aside>
|
|
137
|
+
<div class="tsd-comment tsd-typography">
|
|
138
|
+
<div class="lead">
|
|
139
|
+
<p>unique API key resource identifier</p>
|
|
140
|
+
</div>
|
|
141
|
+
</div>
|
|
142
|
+
</section>
|
|
143
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
144
|
+
<a name="name" class="tsd-anchor"></a>
|
|
145
|
+
<h3>name</h3>
|
|
146
|
+
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
|
+
<aside class="tsd-sources">
|
|
148
|
+
<ul>
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2118">datatypes.ts:2118</a></li>
|
|
150
|
+
</ul>
|
|
151
|
+
</aside>
|
|
152
|
+
<div class="tsd-comment tsd-typography">
|
|
153
|
+
<div class="lead">
|
|
154
|
+
<p>human-readable name used to identify the service</p>
|
|
155
|
+
</div>
|
|
156
|
+
</div>
|
|
157
|
+
</section>
|
|
158
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
159
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
160
|
+
<h3>uri</h3>
|
|
161
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
162
|
+
<aside class="tsd-sources">
|
|
163
|
+
<ul>
|
|
164
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/38e5bd2/src/datatypes.ts#L2116">datatypes.ts:2116</a></li>
|
|
165
|
+
</ul>
|
|
166
|
+
</aside>
|
|
167
|
+
<div class="tsd-comment tsd-typography">
|
|
168
|
+
<div class="lead">
|
|
169
|
+
<p>URI to the API resource of this service user</p>
|
|
170
|
+
</div>
|
|
171
|
+
</div>
|
|
172
|
+
</section>
|
|
173
|
+
</section>
|
|
174
|
+
</div>
|
|
175
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
176
|
+
<nav class="tsd-navigation primary">
|
|
177
|
+
<ul>
|
|
178
|
+
<li class=" ">
|
|
179
|
+
<a href="../modules.html">Modules</a>
|
|
180
|
+
</li>
|
|
181
|
+
<li class=" tsd-kind-module">
|
|
182
|
+
<a href="../modules/client.html">client</a>
|
|
183
|
+
</li>
|
|
184
|
+
<li class="current tsd-kind-module">
|
|
185
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
186
|
+
</li>
|
|
187
|
+
<li class=" tsd-kind-module">
|
|
188
|
+
<a href="../modules/services.html">services</a>
|
|
189
|
+
</li>
|
|
190
|
+
</ul>
|
|
191
|
+
</nav>
|
|
192
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
193
|
+
<ul class="before-current">
|
|
194
|
+
</ul>
|
|
195
|
+
<ul class="current">
|
|
196
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
197
|
+
<a href="datatypes.ServiceUser.html" class="tsd-kind-icon">Service<wbr>User</a>
|
|
198
|
+
<ul>
|
|
199
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
200
|
+
<a href="datatypes.ServiceUser.html#active" class="tsd-kind-icon">active</a>
|
|
201
|
+
</li>
|
|
202
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
203
|
+
<a href="datatypes.ServiceUser.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
204
|
+
</li>
|
|
205
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
206
|
+
<a href="datatypes.ServiceUser.html#id" class="tsd-kind-icon">id</a>
|
|
207
|
+
</li>
|
|
208
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
209
|
+
<a href="datatypes.ServiceUser.html#name" class="tsd-kind-icon">name</a>
|
|
210
|
+
</li>
|
|
211
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
212
|
+
<a href="datatypes.ServiceUser.html#uri" class="tsd-kind-icon">uri</a>
|
|
213
|
+
</li>
|
|
214
|
+
</ul>
|
|
215
|
+
</li>
|
|
216
|
+
</ul>
|
|
217
|
+
<ul class="after-current">
|
|
218
|
+
</ul>
|
|
219
|
+
</nav>
|
|
220
|
+
</div>
|
|
221
|
+
</div>
|
|
222
|
+
</div>
|
|
223
|
+
<footer class="with-border-bottom">
|
|
224
|
+
<div class="container">
|
|
225
|
+
<h2>Legend</h2>
|
|
226
|
+
<div class="tsd-legend-group">
|
|
227
|
+
<ul class="tsd-legend">
|
|
228
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
229
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
230
|
+
</ul>
|
|
231
|
+
<ul class="tsd-legend">
|
|
232
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
233
|
+
</ul>
|
|
234
|
+
</div>
|
|
235
|
+
</div>
|
|
236
|
+
</footer>
|
|
237
|
+
<div class="container tsd-generator">
|
|
238
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
239
|
+
</div>
|
|
240
|
+
<div class="overlay"></div>
|
|
241
|
+
<script src="../assets/js/main.js"></script>
|
|
242
|
+
</body>
|
|
243
|
+
</html>
|