ngrok-api 0.12.0 → 0.14.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.
- checksums.yaml +4 -4
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +184 -182
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +55 -19
- data/doc/NgrokAPI/Models/APIKey.html +1 -1
- data/doc/NgrokAPI/Models/AWSAuth.html +1 -1
- data/doc/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/doc/NgrokAPI/Models/AWSRole.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReport.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/Credential.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/doc/NgrokAPI/Models/EventDestination.html +1 -1
- data/doc/NgrokAPI/Models/EventSource.html +1 -1
- data/doc/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/doc/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/doc/NgrokAPI/Models/EventStream.html +1 -1
- data/doc/NgrokAPI/Models/EventSubscription.html +1 -1
- data/doc/NgrokAPI/Models/EventTarget.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/doc/NgrokAPI/Models/IPRestriction.html +1 -1
- data/doc/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/doc/NgrokAPI/Models/Listable.html +118 -50
- data/doc/NgrokAPI/Models/Ref.html +1 -1
- data/doc/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/SSHCredential.html +1 -1
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/doc/NgrokAPI/Models/Tunnel.html +1 -1
- data/doc/NgrokAPI/Models/TunnelSession.html +1 -1
- data/doc/NgrokAPI/Models.html +3 -3
- data/doc/NgrokAPI/PagedIterator.html +14 -10
- data/doc/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/doc/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/doc/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/doc/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/doc/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/doc/NgrokAPI/Services.html +1 -1
- data/doc/NgrokAPI.html +2 -2
- data/doc/README +94 -0
- data/doc/_index.html +8 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +53 -26
- data/doc/index.html +53 -26
- data/doc/method_list.html +822 -630
- data/doc/top-level-namespace.html +1 -1
- data/docs/NgrokAPI/Client.html +184 -182
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +55 -19
- data/docs/NgrokAPI/Models/APIKey.html +1 -1
- data/docs/NgrokAPI/Models/AWSAuth.html +1 -1
- data/docs/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/docs/NgrokAPI/Models/AWSRole.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReport.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/Credential.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/docs/NgrokAPI/Models/EventDestination.html +1 -1
- data/docs/NgrokAPI/Models/EventSource.html +1 -1
- data/docs/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/docs/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/docs/NgrokAPI/Models/EventStream.html +1 -1
- data/docs/NgrokAPI/Models/EventSubscription.html +1 -1
- data/docs/NgrokAPI/Models/EventTarget.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/docs/NgrokAPI/Models/IPRestriction.html +1 -1
- data/docs/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/docs/NgrokAPI/Models/Listable.html +118 -50
- data/docs/NgrokAPI/Models/Ref.html +1 -1
- data/docs/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/SSHCredential.html +1 -1
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/docs/NgrokAPI/Models/Tunnel.html +1 -1
- data/docs/NgrokAPI/Models/TunnelSession.html +1 -1
- data/docs/NgrokAPI/Models.html +3 -3
- data/docs/NgrokAPI/PagedIterator.html +14 -10
- data/docs/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/docs/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/docs/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/docs/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/docs/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/docs/NgrokAPI/Services.html +1 -1
- data/docs/NgrokAPI.html +2 -2
- data/docs/README +94 -0
- data/docs/_index.html +8 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +53 -26
- data/docs/index.html +53 -26
- data/docs/method_list.html +822 -630
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +27 -8
- data/lib/ngrokapi/http_client.rb +5 -3
- data/lib/ngrokapi/models/{reserved_domain_cert_ns_target.rb → event_source_list.rb} +5 -5
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +1 -3
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/api_keys_client.rb +36 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/credentials_client.rb +35 -2
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +33 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +33 -0
- data/lib/ngrokapi/services/event_sources_client.rb +39 -0
- data/lib/ngrokapi/services/event_streams_client.rb +33 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +34 -1
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +33 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +34 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +33 -0
- data/lib/ngrokapi/services/tunnels_client.rb +33 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +19 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +2 -2
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +0 -2
- data/spec/ngrokapi/services/api_keys_client_spec.rb +0 -3
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_sources_client_spec.rb +33 -3
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +0 -1
- data/spec/spec_helper.rb +7 -0
- metadata +10 -7
- data/doc/.gitkeep +0 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +0 -21
|
@@ -102,13 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>Certificate Authorities are x509 certificates that are used to sign other
|
|
106
|
-
|
|
107
|
-
<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
|
108
|
-
to verify that the TLS certificate presented by a client has been signed by
|
|
109
|
-
this CA. Certificate Authorities are used only for mTLS validation only and
|
|
110
|
-
thus a private key is not included in the resource.
|
|
111
|
-
</code></pre>
|
|
105
|
+
<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p>
|
|
112
106
|
|
|
113
107
|
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities">ngrok.com/docs/api#api-certificate-authorities</a></p>
|
|
114
108
|
|
|
@@ -377,6 +371,30 @@ thus a private key is not included in the resource.
|
|
|
377
371
|
<p>List all Certificate Authority on this account.</p>
|
|
378
372
|
</div></span>
|
|
379
373
|
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all Certificate Authority on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
380
398
|
</li>
|
|
381
399
|
|
|
382
400
|
|
|
@@ -1170,7 +1188,8 @@ thus a private key is not included in the resource.
|
|
|
1170
1188
|
147
|
|
1171
1189
|
148
|
|
1172
1190
|
149
|
|
1173
|
-
150
|
|
1191
|
+
150
|
|
1192
|
+
151</pre>
|
|
1174
1193
|
</td>
|
|
1175
1194
|
<td>
|
|
1176
1195
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 133</span>
|
|
@@ -1186,6 +1205,7 @@ thus a private key is not included in the resource.
|
|
|
1186
1205
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1187
1206
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1188
1207
|
<span class='rparen'>)</span>
|
|
1208
|
+
|
|
1189
1209
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1190
1210
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1191
1211
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
@@ -1196,6 +1216,151 @@ thus a private key is not included in the resource.
|
|
|
1196
1216
|
</td>
|
|
1197
1217
|
</tr>
|
|
1198
1218
|
</table>
|
|
1219
|
+
</div>
|
|
1220
|
+
|
|
1221
|
+
<div class="method_details ">
|
|
1222
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1223
|
+
|
|
1224
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
</h3><div class="docstring">
|
|
1231
|
+
<div class="discussion">
|
|
1232
|
+
|
|
1233
|
+
<p>List all Certificate Authority on this account Throws an exception if API error.</p>
|
|
1234
|
+
|
|
1235
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-list">ngrok.com/docs/api#api-certificate-authorities-list</a></p>
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</div>
|
|
1239
|
+
</div>
|
|
1240
|
+
<div class="tags">
|
|
1241
|
+
<p class="tag_title">Parameters:</p>
|
|
1242
|
+
<ul class="param">
|
|
1243
|
+
|
|
1244
|
+
<li>
|
|
1245
|
+
|
|
1246
|
+
<span class='name'>before_id</span>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
</li>
|
|
1256
|
+
|
|
1257
|
+
<li>
|
|
1258
|
+
|
|
1259
|
+
<span class='name'>limit</span>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
</li>
|
|
1269
|
+
|
|
1270
|
+
<li>
|
|
1271
|
+
|
|
1272
|
+
<span class='name'>url</span>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
—
|
|
1282
|
+
<div class='inline'>
|
|
1283
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1284
|
+
</div>
|
|
1285
|
+
|
|
1286
|
+
</li>
|
|
1287
|
+
|
|
1288
|
+
</ul>
|
|
1289
|
+
|
|
1290
|
+
<p class="tag_title">Returns:</p>
|
|
1291
|
+
<ul class="return">
|
|
1292
|
+
|
|
1293
|
+
<li>
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
—
|
|
1301
|
+
<div class='inline'>
|
|
1302
|
+
<p>result from the API request</p>
|
|
1303
|
+
</div>
|
|
1304
|
+
|
|
1305
|
+
</li>
|
|
1306
|
+
|
|
1307
|
+
</ul>
|
|
1308
|
+
|
|
1309
|
+
</div><table class="source_code">
|
|
1310
|
+
<tr>
|
|
1311
|
+
<td>
|
|
1312
|
+
<pre class="lines">
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
163
|
|
1316
|
+
164
|
|
1317
|
+
165
|
|
1318
|
+
166
|
|
1319
|
+
167
|
|
1320
|
+
168
|
|
1321
|
+
169
|
|
1322
|
+
170
|
|
1323
|
+
171
|
|
1324
|
+
172
|
|
1325
|
+
173
|
|
1326
|
+
174
|
|
1327
|
+
175
|
|
1328
|
+
176
|
|
1329
|
+
177
|
|
1330
|
+
178
|
|
1331
|
+
179
|
|
1332
|
+
180
|
|
1333
|
+
181
|
|
1334
|
+
182
|
|
1335
|
+
183</pre>
|
|
1336
|
+
</td>
|
|
1337
|
+
<td>
|
|
1338
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 163</span>
|
|
1339
|
+
|
|
1340
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1341
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1342
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1343
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1344
|
+
<span class='rparen'>)</span>
|
|
1345
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1346
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1347
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1348
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1349
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1350
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1351
|
+
<span class='rparen'>)</span>
|
|
1352
|
+
|
|
1353
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1354
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1355
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1356
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1357
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='comma'>,</span>
|
|
1358
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1359
|
+
<span class='rparen'>)</span>
|
|
1360
|
+
<span class='kw'>end</span></pre>
|
|
1361
|
+
</td>
|
|
1362
|
+
</tr>
|
|
1363
|
+
</table>
|
|
1199
1364
|
</div>
|
|
1200
1365
|
|
|
1201
1366
|
<div class="method_details ">
|
|
@@ -1297,24 +1462,24 @@ thus a private key is not included in the resource.
|
|
|
1297
1462
|
<pre class="lines">
|
|
1298
1463
|
|
|
1299
1464
|
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1314
|
-
|
|
1465
|
+
194
|
|
1466
|
+
195
|
|
1467
|
+
196
|
|
1468
|
+
197
|
|
1469
|
+
198
|
|
1470
|
+
199
|
|
1471
|
+
200
|
|
1472
|
+
201
|
|
1473
|
+
202
|
|
1474
|
+
203
|
|
1475
|
+
204
|
|
1476
|
+
205
|
|
1477
|
+
206
|
|
1478
|
+
207
|
|
1479
|
+
208</pre>
|
|
1315
1480
|
</td>
|
|
1316
1481
|
<td>
|
|
1317
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1482
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 194</span>
|
|
1318
1483
|
|
|
1319
1484
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1320
1485
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1435,24 +1600,24 @@ thus a private key is not included in the resource.
|
|
|
1435
1600
|
<pre class="lines">
|
|
1436
1601
|
|
|
1437
1602
|
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
1452
|
-
|
|
1603
|
+
220
|
|
1604
|
+
221
|
|
1605
|
+
222
|
|
1606
|
+
223
|
|
1607
|
+
224
|
|
1608
|
+
225
|
|
1609
|
+
226
|
|
1610
|
+
227
|
|
1611
|
+
228
|
|
1612
|
+
229
|
|
1613
|
+
230
|
|
1614
|
+
231
|
|
1615
|
+
232
|
|
1616
|
+
233
|
|
1617
|
+
234</pre>
|
|
1453
1618
|
</td>
|
|
1454
1619
|
<td>
|
|
1455
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1620
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 220</span>
|
|
1456
1621
|
|
|
1457
1622
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1458
1623
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1479,7 +1644,7 @@ thus a private key is not included in the resource.
|
|
|
1479
1644
|
</div>
|
|
1480
1645
|
|
|
1481
1646
|
<div id="footer">
|
|
1482
|
-
Generated on
|
|
1647
|
+
Generated on Tue Oct 19 15:48:25 2021 by
|
|
1483
1648
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1484
1649
|
0.9.26 (ruby-3.0.1).
|
|
1485
1650
|
</div>
|
|
@@ -102,12 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p>
|
|
106
|
-
|
|
107
|
-
<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with
|
|
108
|
-
the ngrok authtoken command or by specifying it in the ngrok.yml
|
|
109
|
-
configuration file with the authtoken property.
|
|
110
|
-
</code></pre>
|
|
105
|
+
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
|
|
111
106
|
|
|
112
107
|
<p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p>
|
|
113
108
|
|
|
@@ -376,6 +371,30 @@ configuration file with the authtoken property.
|
|
|
376
371
|
<p>List all tunnel authtoken credentials on this account.</p>
|
|
377
372
|
</div></span>
|
|
378
373
|
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
379
398
|
</li>
|
|
380
399
|
|
|
381
400
|
|
|
@@ -601,7 +620,7 @@ configuration file with the authtoken property.
|
|
|
601
620
|
|
|
602
621
|
—
|
|
603
622
|
<div class='inline'>
|
|
604
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
623
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
605
624
|
</div>
|
|
606
625
|
|
|
607
626
|
</li>
|
|
@@ -1171,7 +1190,8 @@ configuration file with the authtoken property.
|
|
|
1171
1190
|
149
|
|
1172
1191
|
150
|
|
1173
1192
|
151
|
|
1174
|
-
152
|
|
1193
|
+
152
|
|
1194
|
+
153</pre>
|
|
1175
1195
|
</td>
|
|
1176
1196
|
<td>
|
|
1177
1197
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span>
|
|
@@ -1187,6 +1207,7 @@ configuration file with the authtoken property.
|
|
|
1187
1207
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1188
1208
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
1189
1209
|
<span class='rparen'>)</span>
|
|
1210
|
+
|
|
1190
1211
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1191
1212
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1192
1213
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
@@ -1197,6 +1218,151 @@ configuration file with the authtoken property.
|
|
|
1197
1218
|
</td>
|
|
1198
1219
|
</tr>
|
|
1199
1220
|
</table>
|
|
1221
|
+
</div>
|
|
1222
|
+
|
|
1223
|
+
<div class="method_details ">
|
|
1224
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1225
|
+
|
|
1226
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
</h3><div class="docstring">
|
|
1233
|
+
<div class="discussion">
|
|
1234
|
+
|
|
1235
|
+
<p>List all tunnel authtoken credentials on this account Throws an exception if API error.</p>
|
|
1236
|
+
|
|
1237
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-list">ngrok.com/docs/api#api-credentials-list</a></p>
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
</div>
|
|
1241
|
+
</div>
|
|
1242
|
+
<div class="tags">
|
|
1243
|
+
<p class="tag_title">Parameters:</p>
|
|
1244
|
+
<ul class="param">
|
|
1245
|
+
|
|
1246
|
+
<li>
|
|
1247
|
+
|
|
1248
|
+
<span class='name'>before_id</span>
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
</li>
|
|
1258
|
+
|
|
1259
|
+
<li>
|
|
1260
|
+
|
|
1261
|
+
<span class='name'>limit</span>
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
</li>
|
|
1271
|
+
|
|
1272
|
+
<li>
|
|
1273
|
+
|
|
1274
|
+
<span class='name'>url</span>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
—
|
|
1284
|
+
<div class='inline'>
|
|
1285
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1286
|
+
</div>
|
|
1287
|
+
|
|
1288
|
+
</li>
|
|
1289
|
+
|
|
1290
|
+
</ul>
|
|
1291
|
+
|
|
1292
|
+
<p class="tag_title">Returns:</p>
|
|
1293
|
+
<ul class="return">
|
|
1294
|
+
|
|
1295
|
+
<li>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
—
|
|
1303
|
+
<div class='inline'>
|
|
1304
|
+
<p>result from the API request</p>
|
|
1305
|
+
</div>
|
|
1306
|
+
|
|
1307
|
+
</li>
|
|
1308
|
+
|
|
1309
|
+
</ul>
|
|
1310
|
+
|
|
1311
|
+
</div><table class="source_code">
|
|
1312
|
+
<tr>
|
|
1313
|
+
<td>
|
|
1314
|
+
<pre class="lines">
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
165
|
|
1318
|
+
166
|
|
1319
|
+
167
|
|
1320
|
+
168
|
|
1321
|
+
169
|
|
1322
|
+
170
|
|
1323
|
+
171
|
|
1324
|
+
172
|
|
1325
|
+
173
|
|
1326
|
+
174
|
|
1327
|
+
175
|
|
1328
|
+
176
|
|
1329
|
+
177
|
|
1330
|
+
178
|
|
1331
|
+
179
|
|
1332
|
+
180
|
|
1333
|
+
181
|
|
1334
|
+
182
|
|
1335
|
+
183
|
|
1336
|
+
184
|
|
1337
|
+
185</pre>
|
|
1338
|
+
</td>
|
|
1339
|
+
<td>
|
|
1340
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 165</span>
|
|
1341
|
+
|
|
1342
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1343
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1344
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1345
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1346
|
+
<span class='rparen'>)</span>
|
|
1347
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1348
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1349
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1350
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1351
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1352
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
1353
|
+
<span class='rparen'>)</span>
|
|
1354
|
+
|
|
1355
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1356
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1357
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1358
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1359
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='comma'>,</span>
|
|
1360
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1361
|
+
<span class='rparen'>)</span>
|
|
1362
|
+
<span class='kw'>end</span></pre>
|
|
1363
|
+
</td>
|
|
1364
|
+
</tr>
|
|
1365
|
+
</table>
|
|
1200
1366
|
</div>
|
|
1201
1367
|
|
|
1202
1368
|
<div class="method_details ">
|
|
@@ -1284,7 +1450,7 @@ configuration file with the authtoken property.
|
|
|
1284
1450
|
|
|
1285
1451
|
—
|
|
1286
1452
|
<div class='inline'>
|
|
1287
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
1453
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1288
1454
|
</div>
|
|
1289
1455
|
|
|
1290
1456
|
</li>
|
|
@@ -1316,26 +1482,26 @@ configuration file with the authtoken property.
|
|
|
1316
1482
|
<pre class="lines">
|
|
1317
1483
|
|
|
1318
1484
|
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1485
|
+
197
|
|
1486
|
+
198
|
|
1487
|
+
199
|
|
1488
|
+
200
|
|
1489
|
+
201
|
|
1490
|
+
202
|
|
1491
|
+
203
|
|
1492
|
+
204
|
|
1493
|
+
205
|
|
1494
|
+
206
|
|
1495
|
+
207
|
|
1496
|
+
208
|
|
1497
|
+
209
|
|
1498
|
+
210
|
|
1499
|
+
211
|
|
1500
|
+
212
|
|
1501
|
+
213</pre>
|
|
1336
1502
|
</td>
|
|
1337
1503
|
<td>
|
|
1338
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1504
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 197</span>
|
|
1339
1505
|
|
|
1340
1506
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1341
1507
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1444,7 +1610,7 @@ configuration file with the authtoken property.
|
|
|
1444
1610
|
|
|
1445
1611
|
—
|
|
1446
1612
|
<div class='inline'>
|
|
1447
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
1613
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1448
1614
|
</div>
|
|
1449
1615
|
|
|
1450
1616
|
</li>
|
|
@@ -1476,26 +1642,26 @@ configuration file with the authtoken property.
|
|
|
1476
1642
|
<pre class="lines">
|
|
1477
1643
|
|
|
1478
1644
|
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1645
|
+
226
|
|
1646
|
+
227
|
|
1647
|
+
228
|
|
1648
|
+
229
|
|
1649
|
+
230
|
|
1650
|
+
231
|
|
1651
|
+
232
|
|
1652
|
+
233
|
|
1653
|
+
234
|
|
1654
|
+
235
|
|
1655
|
+
236
|
|
1656
|
+
237
|
|
1657
|
+
238
|
|
1658
|
+
239
|
|
1659
|
+
240
|
|
1660
|
+
241
|
|
1661
|
+
242</pre>
|
|
1496
1662
|
</td>
|
|
1497
1663
|
<td>
|
|
1498
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1664
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 226</span>
|
|
1499
1665
|
|
|
1500
1666
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1501
1667
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1524,7 +1690,7 @@ configuration file with the authtoken property.
|
|
|
1524
1690
|
</div>
|
|
1525
1691
|
|
|
1526
1692
|
<div id="footer">
|
|
1527
|
-
Generated on
|
|
1693
|
+
Generated on Tue Oct 19 15:48:21 2021 by
|
|
1528
1694
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1529
1695
|
0.9.26 (ruby-3.0.1).
|
|
1530
1696
|
</div>
|
|
@@ -1061,7 +1061,7 @@
|
|
|
1061
1061
|
</div>
|
|
1062
1062
|
|
|
1063
1063
|
<div id="footer">
|
|
1064
|
-
Generated on
|
|
1064
|
+
Generated on Tue Oct 19 15:48:26 2021 by
|
|
1065
1065
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1066
1066
|
0.9.26 (ruby-3.0.1).
|
|
1067
1067
|
</div>
|