ngrok-api 0.9.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- 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 +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- 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 +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +42 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -0,0 +1,1534 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::CredentialsClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::CredentialsClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">CredentialsClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::CredentialsClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::CredentialsClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/credentials_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
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>
|
|
111
|
+
|
|
112
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<h2>
|
|
123
|
+
Constant Summary
|
|
124
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
125
|
+
</h2>
|
|
126
|
+
|
|
127
|
+
<dl class="constants">
|
|
128
|
+
|
|
129
|
+
<dt id="PATH-constant" class="">PATH =
|
|
130
|
+
<div class="docstring">
|
|
131
|
+
<div class="discussion">
|
|
132
|
+
|
|
133
|
+
<p>The API path for the requests</p>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</div>
|
|
138
|
+
<div class="tags">
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
</dt>
|
|
143
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
144
|
+
|
|
145
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
146
|
+
<div class="docstring">
|
|
147
|
+
<div class="discussion">
|
|
148
|
+
|
|
149
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</div>
|
|
154
|
+
<div class="tags">
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
</dt>
|
|
159
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>credentials</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
160
|
+
|
|
161
|
+
</dl>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
168
|
+
<ul class="summary">
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="note title readonly">readonly</span>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<span class="summary_desc"><div class='inline'>
|
|
193
|
+
<p>Returns the value of attribute client.</p>
|
|
194
|
+
</div></span>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</ul>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<h2>
|
|
206
|
+
Instance Method Summary
|
|
207
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
208
|
+
</h2>
|
|
209
|
+
|
|
210
|
+
<ul class="summary">
|
|
211
|
+
|
|
212
|
+
<li class="public ">
|
|
213
|
+
<span class="summary_signature">
|
|
214
|
+
|
|
215
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: []) ⇒ NgrokAPI::Models::Credential </a>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</span>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<span class="summary_desc"><div class='inline'>
|
|
230
|
+
<p>Create a new tunnel authtoken credential.</p>
|
|
231
|
+
</div></span>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<li class="public ">
|
|
237
|
+
<span class="summary_signature">
|
|
238
|
+
|
|
239
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</span>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class="summary_desc"><div class='inline'>
|
|
254
|
+
<p>Delete a tunnel authtoken credential by ID.</p>
|
|
255
|
+
</div></span>
|
|
256
|
+
|
|
257
|
+
</li>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<li class="public ">
|
|
261
|
+
<span class="summary_signature">
|
|
262
|
+
|
|
263
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class="summary_desc"><div class='inline'>
|
|
278
|
+
<p>Delete a tunnel authtoken credential by ID Throws an exception if API error.</p>
|
|
279
|
+
</div></span>
|
|
280
|
+
|
|
281
|
+
</li>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<li class="public ">
|
|
285
|
+
<span class="summary_signature">
|
|
286
|
+
|
|
287
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::Credential </a>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="summary_desc"><div class='inline'>
|
|
302
|
+
<p>Get detailed information about a tunnel authtoken credential.</p>
|
|
303
|
+
</div></span>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<li class="public ">
|
|
309
|
+
<span class="summary_signature">
|
|
310
|
+
|
|
311
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::Credential </a>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</span>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<span class="summary_desc"><div class='inline'>
|
|
326
|
+
<p>Get detailed information about a tunnel authtoken credential Throws an exception if API error.</p>
|
|
327
|
+
</div></span>
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<li class="public ">
|
|
333
|
+
<span class="summary_signature">
|
|
334
|
+
|
|
335
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ CredentialsClient </a>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</span>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="note title constructor">constructor</span>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class="summary_desc"><div class='inline'>
|
|
352
|
+
<p>A new instance of CredentialsClient.</p>
|
|
353
|
+
</div></span>
|
|
354
|
+
|
|
355
|
+
</li>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<li class="public ">
|
|
359
|
+
<span class="summary_signature">
|
|
360
|
+
|
|
361
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<span class="summary_desc"><div class='inline'>
|
|
376
|
+
<p>List all tunnel authtoken credentials on this account.</p>
|
|
377
|
+
</div></span>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<li class="public ">
|
|
383
|
+
<span class="summary_signature">
|
|
384
|
+
|
|
385
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::Credential </a>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<span class="summary_desc"><div class='inline'>
|
|
400
|
+
<p>Update attributes of an tunnel authtoken credential by ID.</p>
|
|
401
|
+
</div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::Credential </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'>
|
|
424
|
+
<p>Update attributes of an tunnel authtoken credential by ID Throws an exception if API error.</p>
|
|
425
|
+
</div></span>
|
|
426
|
+
|
|
427
|
+
</li>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</ul>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div id="constructor_details" class="method_details_list">
|
|
434
|
+
<h2>Constructor Details</h2>
|
|
435
|
+
|
|
436
|
+
<div class="method_details first">
|
|
437
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
438
|
+
|
|
439
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></tt>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
</h3><div class="docstring">
|
|
446
|
+
<div class="discussion">
|
|
447
|
+
|
|
448
|
+
<p>Returns a new instance of CredentialsClient.</p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
<div class="tags">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</div><table class="source_code">
|
|
457
|
+
<tr>
|
|
458
|
+
<td>
|
|
459
|
+
<pre class="lines">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
20
|
|
463
|
+
21
|
|
464
|
+
22</pre>
|
|
465
|
+
</td>
|
|
466
|
+
<td>
|
|
467
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 20</span>
|
|
468
|
+
|
|
469
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
470
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
471
|
+
<span class='kw'>end</span></pre>
|
|
472
|
+
</td>
|
|
473
|
+
</tr>
|
|
474
|
+
</table>
|
|
475
|
+
</div>
|
|
476
|
+
|
|
477
|
+
</div>
|
|
478
|
+
|
|
479
|
+
<div id="instance_attr_details" class="attr_details">
|
|
480
|
+
<h2>Instance Attribute Details</h2>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<span id=""></span>
|
|
484
|
+
<div class="method_details first">
|
|
485
|
+
<h3 class="signature first" id="client-instance_method">
|
|
486
|
+
|
|
487
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</h3><div class="docstring">
|
|
494
|
+
<div class="discussion">
|
|
495
|
+
|
|
496
|
+
<p>Returns the value of attribute client.</p>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</div>
|
|
500
|
+
</div>
|
|
501
|
+
<div class="tags">
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</div><table class="source_code">
|
|
505
|
+
<tr>
|
|
506
|
+
<td>
|
|
507
|
+
<pre class="lines">
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
18
|
|
511
|
+
19
|
|
512
|
+
20</pre>
|
|
513
|
+
</td>
|
|
514
|
+
<td>
|
|
515
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 18</span>
|
|
516
|
+
|
|
517
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
518
|
+
<span class='ivar'>@client</span>
|
|
519
|
+
<span class='kw'>end</span></pre>
|
|
520
|
+
</td>
|
|
521
|
+
</tr>
|
|
522
|
+
</table>
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<div id="instance_method_details" class="method_details_list">
|
|
529
|
+
<h2>Instance Method Details</h2>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<div class="method_details first">
|
|
533
|
+
<h3 class="signature first" id="create-instance_method">
|
|
534
|
+
|
|
535
|
+
#<strong>create</strong>(description: "", metadata: "", acl: []) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</h3><div class="docstring">
|
|
542
|
+
<div class="discussion">
|
|
543
|
+
|
|
544
|
+
<p>Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.</p>
|
|
545
|
+
|
|
546
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-create">ngrok.com/docs/api#api-credentials-create</a></p>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</div>
|
|
551
|
+
<div class="tags">
|
|
552
|
+
<p class="tag_title">Parameters:</p>
|
|
553
|
+
<ul class="param">
|
|
554
|
+
|
|
555
|
+
<li>
|
|
556
|
+
|
|
557
|
+
<span class='name'>description</span>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
—
|
|
567
|
+
<div class='inline'>
|
|
568
|
+
<p>human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p>
|
|
569
|
+
</div>
|
|
570
|
+
|
|
571
|
+
</li>
|
|
572
|
+
|
|
573
|
+
<li>
|
|
574
|
+
|
|
575
|
+
<span class='name'>metadata</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
—
|
|
585
|
+
<div class='inline'>
|
|
586
|
+
<p>arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
<li>
|
|
592
|
+
|
|
593
|
+
<span class='name'>acl</span>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
—
|
|
603
|
+
<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 “bind“ rule. The “bind“ 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 “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
605
|
+
</div>
|
|
606
|
+
|
|
607
|
+
</li>
|
|
608
|
+
|
|
609
|
+
</ul>
|
|
610
|
+
|
|
611
|
+
<p class="tag_title">Returns:</p>
|
|
612
|
+
<ul class="return">
|
|
613
|
+
|
|
614
|
+
<li>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
—
|
|
622
|
+
<div class='inline'>
|
|
623
|
+
<p>result from the API request</p>
|
|
624
|
+
</div>
|
|
625
|
+
|
|
626
|
+
</li>
|
|
627
|
+
|
|
628
|
+
</ul>
|
|
629
|
+
|
|
630
|
+
</div><table class="source_code">
|
|
631
|
+
<tr>
|
|
632
|
+
<td>
|
|
633
|
+
<pre class="lines">
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
36
|
|
637
|
+
37
|
|
638
|
+
38
|
|
639
|
+
39
|
|
640
|
+
40
|
|
641
|
+
41
|
|
642
|
+
42
|
|
643
|
+
43
|
|
644
|
+
44
|
|
645
|
+
45
|
|
646
|
+
46
|
|
647
|
+
47
|
|
648
|
+
48
|
|
649
|
+
49
|
|
650
|
+
50</pre>
|
|
651
|
+
</td>
|
|
652
|
+
<td>
|
|
653
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 36</span>
|
|
654
|
+
|
|
655
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
656
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
657
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
658
|
+
<span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
659
|
+
<span class='rparen'>)</span>
|
|
660
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span>
|
|
661
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
662
|
+
<span class='rbrace'>}</span>
|
|
663
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
664
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
665
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
666
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
|
|
667
|
+
<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_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
668
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
669
|
+
<span class='kw'>end</span></pre>
|
|
670
|
+
</td>
|
|
671
|
+
</tr>
|
|
672
|
+
</table>
|
|
673
|
+
</div>
|
|
674
|
+
|
|
675
|
+
<div class="method_details ">
|
|
676
|
+
<h3 class="signature " id="delete-instance_method">
|
|
677
|
+
|
|
678
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
</h3><div class="docstring">
|
|
685
|
+
<div class="discussion">
|
|
686
|
+
|
|
687
|
+
<p>Delete a tunnel authtoken credential by ID</p>
|
|
688
|
+
|
|
689
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-delete">ngrok.com/docs/api#api-credentials-delete</a></p>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
</div>
|
|
693
|
+
</div>
|
|
694
|
+
<div class="tags">
|
|
695
|
+
<p class="tag_title">Parameters:</p>
|
|
696
|
+
<ul class="param">
|
|
697
|
+
|
|
698
|
+
<li>
|
|
699
|
+
|
|
700
|
+
<span class='name'>id</span>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
—
|
|
710
|
+
<div class='inline'>
|
|
711
|
+
<p>a resource identifier</p>
|
|
712
|
+
</div>
|
|
713
|
+
|
|
714
|
+
</li>
|
|
715
|
+
|
|
716
|
+
</ul>
|
|
717
|
+
|
|
718
|
+
<p class="tag_title">Returns:</p>
|
|
719
|
+
<ul class="return">
|
|
720
|
+
|
|
721
|
+
<li>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
—
|
|
729
|
+
<div class='inline'>
|
|
730
|
+
<p>result from the API request</p>
|
|
731
|
+
</div>
|
|
732
|
+
|
|
733
|
+
</li>
|
|
734
|
+
|
|
735
|
+
</ul>
|
|
736
|
+
|
|
737
|
+
</div><table class="source_code">
|
|
738
|
+
<tr>
|
|
739
|
+
<td>
|
|
740
|
+
<pre class="lines">
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
59
|
|
744
|
+
60
|
|
745
|
+
61
|
|
746
|
+
62
|
|
747
|
+
63
|
|
748
|
+
64
|
|
749
|
+
65
|
|
750
|
+
66
|
|
751
|
+
67</pre>
|
|
752
|
+
</td>
|
|
753
|
+
<td>
|
|
754
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 59</span>
|
|
755
|
+
|
|
756
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
757
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
758
|
+
<span class='rparen'>)</span>
|
|
759
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
760
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
761
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
762
|
+
<span class='rbrace'>}</span>
|
|
763
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
764
|
+
<span class='kw'>end</span></pre>
|
|
765
|
+
</td>
|
|
766
|
+
</tr>
|
|
767
|
+
</table>
|
|
768
|
+
</div>
|
|
769
|
+
|
|
770
|
+
<div class="method_details ">
|
|
771
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
772
|
+
|
|
773
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
</h3><div class="docstring">
|
|
780
|
+
<div class="discussion">
|
|
781
|
+
|
|
782
|
+
<p>Delete a tunnel authtoken credential by ID Throws an exception if API error.</p>
|
|
783
|
+
|
|
784
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-delete">ngrok.com/docs/api#api-credentials-delete</a></p>
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</div>
|
|
788
|
+
</div>
|
|
789
|
+
<div class="tags">
|
|
790
|
+
<p class="tag_title">Parameters:</p>
|
|
791
|
+
<ul class="param">
|
|
792
|
+
|
|
793
|
+
<li>
|
|
794
|
+
|
|
795
|
+
<span class='name'>id</span>
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
—
|
|
805
|
+
<div class='inline'>
|
|
806
|
+
<p>a resource identifier</p>
|
|
807
|
+
</div>
|
|
808
|
+
|
|
809
|
+
</li>
|
|
810
|
+
|
|
811
|
+
</ul>
|
|
812
|
+
|
|
813
|
+
<p class="tag_title">Returns:</p>
|
|
814
|
+
<ul class="return">
|
|
815
|
+
|
|
816
|
+
<li>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
—
|
|
824
|
+
<div class='inline'>
|
|
825
|
+
<p>result from the API request</p>
|
|
826
|
+
</div>
|
|
827
|
+
|
|
828
|
+
</li>
|
|
829
|
+
|
|
830
|
+
</ul>
|
|
831
|
+
|
|
832
|
+
</div><table class="source_code">
|
|
833
|
+
<tr>
|
|
834
|
+
<td>
|
|
835
|
+
<pre class="lines">
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
77
|
|
839
|
+
78
|
|
840
|
+
79
|
|
841
|
+
80
|
|
842
|
+
81
|
|
843
|
+
82
|
|
844
|
+
83
|
|
845
|
+
84
|
|
846
|
+
85</pre>
|
|
847
|
+
</td>
|
|
848
|
+
<td>
|
|
849
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 77</span>
|
|
850
|
+
|
|
851
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
852
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
853
|
+
<span class='rparen'>)</span>
|
|
854
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
855
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
856
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
857
|
+
<span class='rbrace'>}</span>
|
|
858
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
859
|
+
<span class='kw'>end</span></pre>
|
|
860
|
+
</td>
|
|
861
|
+
</tr>
|
|
862
|
+
</table>
|
|
863
|
+
</div>
|
|
864
|
+
|
|
865
|
+
<div class="method_details ">
|
|
866
|
+
<h3 class="signature " id="get-instance_method">
|
|
867
|
+
|
|
868
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
</h3><div class="docstring">
|
|
875
|
+
<div class="discussion">
|
|
876
|
+
|
|
877
|
+
<p>Get detailed information about a tunnel authtoken credential</p>
|
|
878
|
+
|
|
879
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-get">ngrok.com/docs/api#api-credentials-get</a></p>
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
</div>
|
|
883
|
+
</div>
|
|
884
|
+
<div class="tags">
|
|
885
|
+
<p class="tag_title">Parameters:</p>
|
|
886
|
+
<ul class="param">
|
|
887
|
+
|
|
888
|
+
<li>
|
|
889
|
+
|
|
890
|
+
<span class='name'>id</span>
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
—
|
|
900
|
+
<div class='inline'>
|
|
901
|
+
<p>a resource identifier</p>
|
|
902
|
+
</div>
|
|
903
|
+
|
|
904
|
+
</li>
|
|
905
|
+
|
|
906
|
+
</ul>
|
|
907
|
+
|
|
908
|
+
<p class="tag_title">Returns:</p>
|
|
909
|
+
<ul class="return">
|
|
910
|
+
|
|
911
|
+
<li>
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
—
|
|
919
|
+
<div class='inline'>
|
|
920
|
+
<p>result from the API request</p>
|
|
921
|
+
</div>
|
|
922
|
+
|
|
923
|
+
</li>
|
|
924
|
+
|
|
925
|
+
</ul>
|
|
926
|
+
|
|
927
|
+
</div><table class="source_code">
|
|
928
|
+
<tr>
|
|
929
|
+
<td>
|
|
930
|
+
<pre class="lines">
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
94
|
|
934
|
+
95
|
|
935
|
+
96
|
|
936
|
+
97
|
|
937
|
+
98
|
|
938
|
+
99
|
|
939
|
+
100
|
|
940
|
+
101
|
|
941
|
+
102
|
|
942
|
+
103
|
|
943
|
+
104</pre>
|
|
944
|
+
</td>
|
|
945
|
+
<td>
|
|
946
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 94</span>
|
|
947
|
+
|
|
948
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
949
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
950
|
+
<span class='rparen'>)</span>
|
|
951
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
952
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
953
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
954
|
+
<span class='rbrace'>}</span>
|
|
955
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
956
|
+
<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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
957
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
958
|
+
<span class='kw'>end</span></pre>
|
|
959
|
+
</td>
|
|
960
|
+
</tr>
|
|
961
|
+
</table>
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
<div class="method_details ">
|
|
965
|
+
<h3 class="signature " id="get!-instance_method">
|
|
966
|
+
|
|
967
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
</h3><div class="docstring">
|
|
974
|
+
<div class="discussion">
|
|
975
|
+
|
|
976
|
+
<p>Get detailed information about a tunnel authtoken credential Throws an exception if API error.</p>
|
|
977
|
+
|
|
978
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-get">ngrok.com/docs/api#api-credentials-get</a></p>
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
</div>
|
|
982
|
+
</div>
|
|
983
|
+
<div class="tags">
|
|
984
|
+
<p class="tag_title">Parameters:</p>
|
|
985
|
+
<ul class="param">
|
|
986
|
+
|
|
987
|
+
<li>
|
|
988
|
+
|
|
989
|
+
<span class='name'>id</span>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
—
|
|
999
|
+
<div class='inline'>
|
|
1000
|
+
<p>a resource identifier</p>
|
|
1001
|
+
</div>
|
|
1002
|
+
|
|
1003
|
+
</li>
|
|
1004
|
+
|
|
1005
|
+
</ul>
|
|
1006
|
+
|
|
1007
|
+
<p class="tag_title">Returns:</p>
|
|
1008
|
+
<ul class="return">
|
|
1009
|
+
|
|
1010
|
+
<li>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
—
|
|
1018
|
+
<div class='inline'>
|
|
1019
|
+
<p>result from the API request</p>
|
|
1020
|
+
</div>
|
|
1021
|
+
|
|
1022
|
+
</li>
|
|
1023
|
+
|
|
1024
|
+
</ul>
|
|
1025
|
+
|
|
1026
|
+
</div><table class="source_code">
|
|
1027
|
+
<tr>
|
|
1028
|
+
<td>
|
|
1029
|
+
<pre class="lines">
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
114
|
|
1033
|
+
115
|
|
1034
|
+
116
|
|
1035
|
+
117
|
|
1036
|
+
118
|
|
1037
|
+
119
|
|
1038
|
+
120
|
|
1039
|
+
121
|
|
1040
|
+
122
|
|
1041
|
+
123
|
|
1042
|
+
124</pre>
|
|
1043
|
+
</td>
|
|
1044
|
+
<td>
|
|
1045
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 114</span>
|
|
1046
|
+
|
|
1047
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1048
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1049
|
+
<span class='rparen'>)</span>
|
|
1050
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1051
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1052
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1053
|
+
<span class='rbrace'>}</span>
|
|
1054
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1055
|
+
<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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1056
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1057
|
+
<span class='kw'>end</span></pre>
|
|
1058
|
+
</td>
|
|
1059
|
+
</tr>
|
|
1060
|
+
</table>
|
|
1061
|
+
</div>
|
|
1062
|
+
|
|
1063
|
+
<div class="method_details ">
|
|
1064
|
+
<h3 class="signature " id="list-instance_method">
|
|
1065
|
+
|
|
1066
|
+
#<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>
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
</h3><div class="docstring">
|
|
1073
|
+
<div class="discussion">
|
|
1074
|
+
|
|
1075
|
+
<p>List all tunnel authtoken credentials on this account</p>
|
|
1076
|
+
|
|
1077
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-list">ngrok.com/docs/api#api-credentials-list</a></p>
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
</div>
|
|
1081
|
+
</div>
|
|
1082
|
+
<div class="tags">
|
|
1083
|
+
<p class="tag_title">Parameters:</p>
|
|
1084
|
+
<ul class="param">
|
|
1085
|
+
|
|
1086
|
+
<li>
|
|
1087
|
+
|
|
1088
|
+
<span class='name'>before_id</span>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
</li>
|
|
1098
|
+
|
|
1099
|
+
<li>
|
|
1100
|
+
|
|
1101
|
+
<span class='name'>limit</span>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
</li>
|
|
1111
|
+
|
|
1112
|
+
<li>
|
|
1113
|
+
|
|
1114
|
+
<span class='name'>url</span>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
—
|
|
1124
|
+
<div class='inline'>
|
|
1125
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1126
|
+
</div>
|
|
1127
|
+
|
|
1128
|
+
</li>
|
|
1129
|
+
|
|
1130
|
+
</ul>
|
|
1131
|
+
|
|
1132
|
+
<p class="tag_title">Returns:</p>
|
|
1133
|
+
<ul class="return">
|
|
1134
|
+
|
|
1135
|
+
<li>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
<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>
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
—
|
|
1143
|
+
<div class='inline'>
|
|
1144
|
+
<p>result from the API request</p>
|
|
1145
|
+
</div>
|
|
1146
|
+
|
|
1147
|
+
</li>
|
|
1148
|
+
|
|
1149
|
+
</ul>
|
|
1150
|
+
|
|
1151
|
+
</div><table class="source_code">
|
|
1152
|
+
<tr>
|
|
1153
|
+
<td>
|
|
1154
|
+
<pre class="lines">
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
135
|
|
1158
|
+
136
|
|
1159
|
+
137
|
|
1160
|
+
138
|
|
1161
|
+
139
|
|
1162
|
+
140
|
|
1163
|
+
141
|
|
1164
|
+
142
|
|
1165
|
+
143
|
|
1166
|
+
144
|
|
1167
|
+
145
|
|
1168
|
+
146
|
|
1169
|
+
147
|
|
1170
|
+
148
|
|
1171
|
+
149
|
|
1172
|
+
150
|
|
1173
|
+
151
|
|
1174
|
+
152</pre>
|
|
1175
|
+
</td>
|
|
1176
|
+
<td>
|
|
1177
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span>
|
|
1178
|
+
|
|
1179
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1180
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1181
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1182
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1183
|
+
<span class='rparen'>)</span>
|
|
1184
|
+
<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>
|
|
1185
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1186
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1187
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1188
|
+
<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
|
+
<span class='rparen'>)</span>
|
|
1190
|
+
<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
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1192
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1193
|
+
<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>
|
|
1194
|
+
<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>
|
|
1195
|
+
<span class='rparen'>)</span>
|
|
1196
|
+
<span class='kw'>end</span></pre>
|
|
1197
|
+
</td>
|
|
1198
|
+
</tr>
|
|
1199
|
+
</table>
|
|
1200
|
+
</div>
|
|
1201
|
+
|
|
1202
|
+
<div class="method_details ">
|
|
1203
|
+
<h3 class="signature " id="update-instance_method">
|
|
1204
|
+
|
|
1205
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, acl: nil) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
</h3><div class="docstring">
|
|
1212
|
+
<div class="discussion">
|
|
1213
|
+
|
|
1214
|
+
<p>Update attributes of an tunnel authtoken credential by ID</p>
|
|
1215
|
+
|
|
1216
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-update">ngrok.com/docs/api#api-credentials-update</a></p>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
</div>
|
|
1220
|
+
</div>
|
|
1221
|
+
<div class="tags">
|
|
1222
|
+
<p class="tag_title">Parameters:</p>
|
|
1223
|
+
<ul class="param">
|
|
1224
|
+
|
|
1225
|
+
<li>
|
|
1226
|
+
|
|
1227
|
+
<span class='name'>id</span>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
</li>
|
|
1237
|
+
|
|
1238
|
+
<li>
|
|
1239
|
+
|
|
1240
|
+
<span class='name'>description</span>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
—
|
|
1250
|
+
<div class='inline'>
|
|
1251
|
+
<p>human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p>
|
|
1252
|
+
</div>
|
|
1253
|
+
|
|
1254
|
+
</li>
|
|
1255
|
+
|
|
1256
|
+
<li>
|
|
1257
|
+
|
|
1258
|
+
<span class='name'>metadata</span>
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
—
|
|
1268
|
+
<div class='inline'>
|
|
1269
|
+
<p>arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p>
|
|
1270
|
+
</div>
|
|
1271
|
+
|
|
1272
|
+
</li>
|
|
1273
|
+
|
|
1274
|
+
<li>
|
|
1275
|
+
|
|
1276
|
+
<span class='name'>acl</span>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
—
|
|
1286
|
+
<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 “bind“ rule. The “bind“ 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 “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1288
|
+
</div>
|
|
1289
|
+
|
|
1290
|
+
</li>
|
|
1291
|
+
|
|
1292
|
+
</ul>
|
|
1293
|
+
|
|
1294
|
+
<p class="tag_title">Returns:</p>
|
|
1295
|
+
<ul class="return">
|
|
1296
|
+
|
|
1297
|
+
<li>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
—
|
|
1305
|
+
<div class='inline'>
|
|
1306
|
+
<p>result from the API request</p>
|
|
1307
|
+
</div>
|
|
1308
|
+
|
|
1309
|
+
</li>
|
|
1310
|
+
|
|
1311
|
+
</ul>
|
|
1312
|
+
|
|
1313
|
+
</div><table class="source_code">
|
|
1314
|
+
<tr>
|
|
1315
|
+
<td>
|
|
1316
|
+
<pre class="lines">
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
164
|
|
1320
|
+
165
|
|
1321
|
+
166
|
|
1322
|
+
167
|
|
1323
|
+
168
|
|
1324
|
+
169
|
|
1325
|
+
170
|
|
1326
|
+
171
|
|
1327
|
+
172
|
|
1328
|
+
173
|
|
1329
|
+
174
|
|
1330
|
+
175
|
|
1331
|
+
176
|
|
1332
|
+
177
|
|
1333
|
+
178
|
|
1334
|
+
179
|
|
1335
|
+
180</pre>
|
|
1336
|
+
</td>
|
|
1337
|
+
<td>
|
|
1338
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 164</span>
|
|
1339
|
+
|
|
1340
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1341
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1342
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1343
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1344
|
+
<span class='label'>acl:</span> <span class='kw'>nil</span>
|
|
1345
|
+
<span class='rparen'>)</span>
|
|
1346
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1347
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1348
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1349
|
+
<span class='rbrace'>}</span>
|
|
1350
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1351
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1352
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1353
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
|
|
1354
|
+
<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_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
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/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1356
|
+
<span class='kw'>end</span></pre>
|
|
1357
|
+
</td>
|
|
1358
|
+
</tr>
|
|
1359
|
+
</table>
|
|
1360
|
+
</div>
|
|
1361
|
+
|
|
1362
|
+
<div class="method_details ">
|
|
1363
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1364
|
+
|
|
1365
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, acl: nil) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
</h3><div class="docstring">
|
|
1372
|
+
<div class="discussion">
|
|
1373
|
+
|
|
1374
|
+
<p>Update attributes of an tunnel authtoken credential by ID Throws an exception if API error.</p>
|
|
1375
|
+
|
|
1376
|
+
<p><a href="https://ngrok.com/docs/api#api-credentials-update">ngrok.com/docs/api#api-credentials-update</a></p>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
</div>
|
|
1380
|
+
</div>
|
|
1381
|
+
<div class="tags">
|
|
1382
|
+
<p class="tag_title">Parameters:</p>
|
|
1383
|
+
<ul class="param">
|
|
1384
|
+
|
|
1385
|
+
<li>
|
|
1386
|
+
|
|
1387
|
+
<span class='name'>id</span>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
</li>
|
|
1397
|
+
|
|
1398
|
+
<li>
|
|
1399
|
+
|
|
1400
|
+
<span class='name'>description</span>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
—
|
|
1410
|
+
<div class='inline'>
|
|
1411
|
+
<p>human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.</p>
|
|
1412
|
+
</div>
|
|
1413
|
+
|
|
1414
|
+
</li>
|
|
1415
|
+
|
|
1416
|
+
<li>
|
|
1417
|
+
|
|
1418
|
+
<span class='name'>metadata</span>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
—
|
|
1428
|
+
<div class='inline'>
|
|
1429
|
+
<p>arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.</p>
|
|
1430
|
+
</div>
|
|
1431
|
+
|
|
1432
|
+
</li>
|
|
1433
|
+
|
|
1434
|
+
<li>
|
|
1435
|
+
|
|
1436
|
+
<span class='name'>acl</span>
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
—
|
|
1446
|
+
<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 “bind“ rule. The “bind“ 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 “bind:example.ngrok.io“. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of “bind:*.example.com“ which will allow “x.example.com“, “y.example.com“, “*.example.com“, etc. A rule of “'*'“ is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1448
|
+
</div>
|
|
1449
|
+
|
|
1450
|
+
</li>
|
|
1451
|
+
|
|
1452
|
+
</ul>
|
|
1453
|
+
|
|
1454
|
+
<p class="tag_title">Returns:</p>
|
|
1455
|
+
<ul class="return">
|
|
1456
|
+
|
|
1457
|
+
<li>
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>)</span>
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
—
|
|
1465
|
+
<div class='inline'>
|
|
1466
|
+
<p>result from the API request</p>
|
|
1467
|
+
</div>
|
|
1468
|
+
|
|
1469
|
+
</li>
|
|
1470
|
+
|
|
1471
|
+
</ul>
|
|
1472
|
+
|
|
1473
|
+
</div><table class="source_code">
|
|
1474
|
+
<tr>
|
|
1475
|
+
<td>
|
|
1476
|
+
<pre class="lines">
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
193
|
|
1480
|
+
194
|
|
1481
|
+
195
|
|
1482
|
+
196
|
|
1483
|
+
197
|
|
1484
|
+
198
|
|
1485
|
+
199
|
|
1486
|
+
200
|
|
1487
|
+
201
|
|
1488
|
+
202
|
|
1489
|
+
203
|
|
1490
|
+
204
|
|
1491
|
+
205
|
|
1492
|
+
206
|
|
1493
|
+
207
|
|
1494
|
+
208
|
|
1495
|
+
209</pre>
|
|
1496
|
+
</td>
|
|
1497
|
+
<td>
|
|
1498
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 193</span>
|
|
1499
|
+
|
|
1500
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1501
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1502
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1503
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1504
|
+
<span class='label'>acl:</span> <span class='kw'>nil</span>
|
|
1505
|
+
<span class='rparen'>)</span>
|
|
1506
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1507
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1508
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1509
|
+
<span class='rbrace'>}</span>
|
|
1510
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1511
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1512
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1513
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
|
|
1514
|
+
<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_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1515
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1516
|
+
<span class='kw'>end</span></pre>
|
|
1517
|
+
</td>
|
|
1518
|
+
</tr>
|
|
1519
|
+
</table>
|
|
1520
|
+
</div>
|
|
1521
|
+
|
|
1522
|
+
</div>
|
|
1523
|
+
|
|
1524
|
+
</div>
|
|
1525
|
+
|
|
1526
|
+
<div id="footer">
|
|
1527
|
+
Generated on Mon Oct 4 23:24:16 2021 by
|
|
1528
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1529
|
+
0.9.26 (ruby-3.0.1).
|
|
1530
|
+
</div>
|
|
1531
|
+
|
|
1532
|
+
</div>
|
|
1533
|
+
</body>
|
|
1534
|
+
</html>
|