ngrok-api 0.9.0 → 0.16.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 +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- 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/AgentIngress.html +1217 -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 +1323 -512
- 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/EventSourceList.html +617 -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/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -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 +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- 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/AgentIngress.html +1217 -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 +1323 -512
- 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/EventSourceList.html +617 -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/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -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 +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -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_list.rb +27 -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/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -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/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -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/agent_ingress_spec.rb +42 -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_list_spec.rb +21 -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/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_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 +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -0,0 +1,1720 @@
|
|
|
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::SSHUserCertificatesClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
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::SSHUserCertificatesClient";
|
|
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 (S)</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">SSHUserCertificatesClient</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::SSHUserCertificatesClient
|
|
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::SSHUserCertificatesClient</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/ssh_user_certificates_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p>
|
|
106
|
+
|
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates">ngrok.com/docs/api#api-ssh-user-certificates</a></p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<h2>
|
|
118
|
+
Constant Summary
|
|
119
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
120
|
+
</h2>
|
|
121
|
+
|
|
122
|
+
<dl class="constants">
|
|
123
|
+
|
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
|
+
<div class="docstring">
|
|
126
|
+
<div class="discussion">
|
|
127
|
+
|
|
128
|
+
<p>The API path for the requests</p>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
<div class="tags">
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
|
+
<div class="docstring">
|
|
142
|
+
<div class="discussion">
|
|
143
|
+
|
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tags">
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</dt>
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ssh_user_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
|
+
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
163
|
+
<ul class="summary">
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="note title readonly">readonly</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>Returns the value of attribute client.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</ul>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<h2>
|
|
201
|
+
Instance Method Summary
|
|
202
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
203
|
+
</h2>
|
|
204
|
+
|
|
205
|
+
<ul class="summary">
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "") ⇒ NgrokAPI::Models::SSHUserCertificate </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Create a new SSH User Certificate.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Delete an SSH User Certificate.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Delete an SSH User Certificate Throws an exception if API error.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>Get detailed information about an SSH User Certficate.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::SSHUserCertificate </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Get detailed information about an SSH User Certficate Throws an exception if API error.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ SSHUserCertificatesClient </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="note title constructor">constructor</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span class="summary_desc"><div class='inline'>
|
|
347
|
+
<p>A new instance of SSHUserCertificatesClient.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'>
|
|
371
|
+
<p>List all SSH User Certificates issued on this account.</p>
|
|
372
|
+
</div></span>
|
|
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 SSH User Certificates issued on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate </a>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
|
419
|
+
<p>Update an SSH User Certificate.</p>
|
|
420
|
+
</div></span>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHUserCertificate </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>Update an SSH User Certificate Throws an exception if API error.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</ul>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<div id="constructor_details" class="method_details_list">
|
|
453
|
+
<h2>Constructor Details</h2>
|
|
454
|
+
|
|
455
|
+
<div class="method_details first">
|
|
456
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
457
|
+
|
|
458
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></tt>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</h3><div class="docstring">
|
|
465
|
+
<div class="discussion">
|
|
466
|
+
|
|
467
|
+
<p>Returns a new instance of SSHUserCertificatesClient.</p>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
</div>
|
|
472
|
+
<div class="tags">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</div><table class="source_code">
|
|
476
|
+
<tr>
|
|
477
|
+
<td>
|
|
478
|
+
<pre class="lines">
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
19
|
|
482
|
+
20
|
|
483
|
+
21</pre>
|
|
484
|
+
</td>
|
|
485
|
+
<td>
|
|
486
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 19</span>
|
|
487
|
+
|
|
488
|
+
<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>
|
|
489
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
490
|
+
<span class='kw'>end</span></pre>
|
|
491
|
+
</td>
|
|
492
|
+
</tr>
|
|
493
|
+
</table>
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
</div>
|
|
497
|
+
|
|
498
|
+
<div id="instance_attr_details" class="attr_details">
|
|
499
|
+
<h2>Instance Attribute Details</h2>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<span id=""></span>
|
|
503
|
+
<div class="method_details first">
|
|
504
|
+
<h3 class="signature first" id="client-instance_method">
|
|
505
|
+
|
|
506
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</h3><div class="docstring">
|
|
513
|
+
<div class="discussion">
|
|
514
|
+
|
|
515
|
+
<p>Returns the value of attribute client.</p>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
</div>
|
|
520
|
+
<div class="tags">
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div><table class="source_code">
|
|
524
|
+
<tr>
|
|
525
|
+
<td>
|
|
526
|
+
<pre class="lines">
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
17
|
|
530
|
+
18
|
|
531
|
+
19</pre>
|
|
532
|
+
</td>
|
|
533
|
+
<td>
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 17</span>
|
|
535
|
+
|
|
536
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
537
|
+
<span class='ivar'>@client</span>
|
|
538
|
+
<span class='kw'>end</span></pre>
|
|
539
|
+
</td>
|
|
540
|
+
</tr>
|
|
541
|
+
</table>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<div id="instance_method_details" class="method_details_list">
|
|
548
|
+
<h2>Instance Method Details</h2>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<div class="method_details first">
|
|
552
|
+
<h3 class="signature first" id="create-instance_method">
|
|
553
|
+
|
|
554
|
+
#<strong>create</strong>(ssh_certificate_authority_id:, public_key:, principals: [], critical_options: {}, extensions: {}, valid_after: "", valid_until: "", description: "", metadata: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</h3><div class="docstring">
|
|
561
|
+
<div class="discussion">
|
|
562
|
+
|
|
563
|
+
<p>Create a new SSH User Certificate</p>
|
|
564
|
+
|
|
565
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-create">ngrok.com/docs/api#api-ssh-user-certificates-create</a></p>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
</div>
|
|
569
|
+
</div>
|
|
570
|
+
<div class="tags">
|
|
571
|
+
<p class="tag_title">Parameters:</p>
|
|
572
|
+
<ul class="param">
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
<span class='name'>ssh_certificate_authority_id</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>the ssh certificate authority that is used to sign this ssh user certificate</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>public_key</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
—
|
|
600
|
+
<div class='inline'>
|
|
601
|
+
<p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
|
|
602
|
+
</div>
|
|
603
|
+
|
|
604
|
+
</li>
|
|
605
|
+
|
|
606
|
+
<li>
|
|
607
|
+
|
|
608
|
+
<span class='name'>principals</span>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
—
|
|
618
|
+
<div class='inline'>
|
|
619
|
+
<p>the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizinig the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.</p>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
</li>
|
|
623
|
+
|
|
624
|
+
<li>
|
|
625
|
+
|
|
626
|
+
<span class='name'>critical_options</span>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
<span class='type'>(<tt>Map<string, string></tt>)</span>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
—
|
|
636
|
+
<div class='inline'>
|
|
637
|
+
<p>A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: <code>force-command</code> and <code>source-address</code>. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p>
|
|
638
|
+
</div>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
<li>
|
|
643
|
+
|
|
644
|
+
<span class='name'>extensions</span>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<span class='type'>(<tt>Map<string, string></tt>)</span>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
—
|
|
654
|
+
<div class='inline'>
|
|
655
|
+
<p>A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: <code>{"permit-pty": "", "permit-user-rc": ""}</code> OpenSSH understands a number of predefined extensions. See <code>the OpenSSH certificate protocol spec</code> <a href="https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_">github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys`_</a> for additional details.</p>
|
|
656
|
+
</div>
|
|
657
|
+
|
|
658
|
+
</li>
|
|
659
|
+
|
|
660
|
+
<li>
|
|
661
|
+
|
|
662
|
+
<span class='name'>valid_after</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<span class='type'>(<tt>datetime (RFC3339 string)</tt>)</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
—
|
|
672
|
+
<div class='inline'>
|
|
673
|
+
<p>The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</p>
|
|
674
|
+
</div>
|
|
675
|
+
|
|
676
|
+
</li>
|
|
677
|
+
|
|
678
|
+
<li>
|
|
679
|
+
|
|
680
|
+
<span class='name'>valid_until</span>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<span class='type'>(<tt>datetime (RFC3339 string)</tt>)</span>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
—
|
|
690
|
+
<div class='inline'>
|
|
691
|
+
<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
<li>
|
|
697
|
+
|
|
698
|
+
<span class='name'>description</span>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
—
|
|
708
|
+
<div class='inline'>
|
|
709
|
+
<p>human-readable description of this SSH User Certificate. optional, max 255 bytes.</p>
|
|
710
|
+
</div>
|
|
711
|
+
|
|
712
|
+
</li>
|
|
713
|
+
|
|
714
|
+
<li>
|
|
715
|
+
|
|
716
|
+
<span class='name'>metadata</span>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
—
|
|
726
|
+
<div class='inline'>
|
|
727
|
+
<p>arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p>
|
|
728
|
+
</div>
|
|
729
|
+
|
|
730
|
+
</li>
|
|
731
|
+
|
|
732
|
+
</ul>
|
|
733
|
+
|
|
734
|
+
<p class="tag_title">Returns:</p>
|
|
735
|
+
<ul class="return">
|
|
736
|
+
|
|
737
|
+
<li>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>)</span>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
—
|
|
745
|
+
<div class='inline'>
|
|
746
|
+
<p>result from the API request</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
|
|
753
|
+
</div><table class="source_code">
|
|
754
|
+
<tr>
|
|
755
|
+
<td>
|
|
756
|
+
<pre class="lines">
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
38
|
|
760
|
+
39
|
|
761
|
+
40
|
|
762
|
+
41
|
|
763
|
+
42
|
|
764
|
+
43
|
|
765
|
+
44
|
|
766
|
+
45
|
|
767
|
+
46
|
|
768
|
+
47
|
|
769
|
+
48
|
|
770
|
+
49
|
|
771
|
+
50
|
|
772
|
+
51
|
|
773
|
+
52
|
|
774
|
+
53
|
|
775
|
+
54</pre>
|
|
776
|
+
</td>
|
|
777
|
+
<td>
|
|
778
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 38</span>
|
|
779
|
+
|
|
780
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>ssh_certificate_authority_id:</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='comma'>,</span> <span class='label'>principals:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>critical_options:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>extensions:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>valid_after:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>valid_until:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
781
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates</span><span class='tstring_end'>'</span></span>
|
|
782
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
783
|
+
<span class='rbrace'>}</span>
|
|
784
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
785
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ssh_certificate_authority_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ssh_certificate_authority_id'>ssh_certificate_authority_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_ssh_certificate_authority_id'>ssh_certificate_authority_id</span>
|
|
786
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:public_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_public_key'>public_key</span> <span class='kw'>if</span> <span class='id identifier rubyid_public_key'>public_key</span>
|
|
787
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:principals</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_principals'>principals</span> <span class='kw'>if</span> <span class='id identifier rubyid_principals'>principals</span>
|
|
788
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:critical_options</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_critical_options'>critical_options</span> <span class='kw'>if</span> <span class='id identifier rubyid_critical_options'>critical_options</span>
|
|
789
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:extensions</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_extensions'>extensions</span> <span class='kw'>if</span> <span class='id identifier rubyid_extensions'>extensions</span>
|
|
790
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:valid_after</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_after'>valid_after</span> <span class='kw'>if</span> <span class='id identifier rubyid_valid_after'>valid_after</span>
|
|
791
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:valid_until</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_until'>valid_until</span> <span class='kw'>if</span> <span class='id identifier rubyid_valid_until'>valid_until</span>
|
|
792
|
+
<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>
|
|
793
|
+
<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>
|
|
794
|
+
<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>
|
|
795
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#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>
|
|
796
|
+
<span class='kw'>end</span></pre>
|
|
797
|
+
</td>
|
|
798
|
+
</tr>
|
|
799
|
+
</table>
|
|
800
|
+
</div>
|
|
801
|
+
|
|
802
|
+
<div class="method_details ">
|
|
803
|
+
<h3 class="signature " id="delete-instance_method">
|
|
804
|
+
|
|
805
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
</h3><div class="docstring">
|
|
812
|
+
<div class="discussion">
|
|
813
|
+
|
|
814
|
+
<p>Delete an SSH User Certificate</p>
|
|
815
|
+
|
|
816
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-delete">ngrok.com/docs/api#api-ssh-user-certificates-delete</a></p>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
</div>
|
|
820
|
+
</div>
|
|
821
|
+
<div class="tags">
|
|
822
|
+
<p class="tag_title">Parameters:</p>
|
|
823
|
+
<ul class="param">
|
|
824
|
+
|
|
825
|
+
<li>
|
|
826
|
+
|
|
827
|
+
<span class='name'>id</span>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
—
|
|
837
|
+
<div class='inline'>
|
|
838
|
+
<p>a resource identifier</p>
|
|
839
|
+
</div>
|
|
840
|
+
|
|
841
|
+
</li>
|
|
842
|
+
|
|
843
|
+
</ul>
|
|
844
|
+
|
|
845
|
+
<p class="tag_title">Returns:</p>
|
|
846
|
+
<ul class="return">
|
|
847
|
+
|
|
848
|
+
<li>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
—
|
|
856
|
+
<div class='inline'>
|
|
857
|
+
<p>result from the API request</p>
|
|
858
|
+
</div>
|
|
859
|
+
|
|
860
|
+
</li>
|
|
861
|
+
|
|
862
|
+
</ul>
|
|
863
|
+
|
|
864
|
+
</div><table class="source_code">
|
|
865
|
+
<tr>
|
|
866
|
+
<td>
|
|
867
|
+
<pre class="lines">
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
63
|
|
871
|
+
64
|
|
872
|
+
65
|
|
873
|
+
66
|
|
874
|
+
67
|
|
875
|
+
68
|
|
876
|
+
69</pre>
|
|
877
|
+
</td>
|
|
878
|
+
<td>
|
|
879
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 63</span>
|
|
880
|
+
|
|
881
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
882
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
883
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
884
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
885
|
+
<span class='rbrace'>}</span>
|
|
886
|
+
<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>
|
|
887
|
+
<span class='kw'>end</span></pre>
|
|
888
|
+
</td>
|
|
889
|
+
</tr>
|
|
890
|
+
</table>
|
|
891
|
+
</div>
|
|
892
|
+
|
|
893
|
+
<div class="method_details ">
|
|
894
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
895
|
+
|
|
896
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
</h3><div class="docstring">
|
|
903
|
+
<div class="discussion">
|
|
904
|
+
|
|
905
|
+
<p>Delete an SSH User Certificate Throws an exception if API error.</p>
|
|
906
|
+
|
|
907
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-delete">ngrok.com/docs/api#api-ssh-user-certificates-delete</a></p>
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</div>
|
|
911
|
+
</div>
|
|
912
|
+
<div class="tags">
|
|
913
|
+
<p class="tag_title">Parameters:</p>
|
|
914
|
+
<ul class="param">
|
|
915
|
+
|
|
916
|
+
<li>
|
|
917
|
+
|
|
918
|
+
<span class='name'>id</span>
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
—
|
|
928
|
+
<div class='inline'>
|
|
929
|
+
<p>a resource identifier</p>
|
|
930
|
+
</div>
|
|
931
|
+
|
|
932
|
+
</li>
|
|
933
|
+
|
|
934
|
+
</ul>
|
|
935
|
+
|
|
936
|
+
<p class="tag_title">Returns:</p>
|
|
937
|
+
<ul class="return">
|
|
938
|
+
|
|
939
|
+
<li>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
—
|
|
947
|
+
<div class='inline'>
|
|
948
|
+
<p>result from the API request</p>
|
|
949
|
+
</div>
|
|
950
|
+
|
|
951
|
+
</li>
|
|
952
|
+
|
|
953
|
+
</ul>
|
|
954
|
+
|
|
955
|
+
</div><table class="source_code">
|
|
956
|
+
<tr>
|
|
957
|
+
<td>
|
|
958
|
+
<pre class="lines">
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
79
|
|
962
|
+
80
|
|
963
|
+
81
|
|
964
|
+
82
|
|
965
|
+
83
|
|
966
|
+
84
|
|
967
|
+
85</pre>
|
|
968
|
+
</td>
|
|
969
|
+
<td>
|
|
970
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 79</span>
|
|
971
|
+
|
|
972
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
973
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
974
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
975
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
976
|
+
<span class='rbrace'>}</span>
|
|
977
|
+
<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>
|
|
978
|
+
<span class='kw'>end</span></pre>
|
|
979
|
+
</td>
|
|
980
|
+
</tr>
|
|
981
|
+
</table>
|
|
982
|
+
</div>
|
|
983
|
+
|
|
984
|
+
<div class="method_details ">
|
|
985
|
+
<h3 class="signature " id="get-instance_method">
|
|
986
|
+
|
|
987
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
</h3><div class="docstring">
|
|
994
|
+
<div class="discussion">
|
|
995
|
+
|
|
996
|
+
<p>Get detailed information about an SSH User Certficate</p>
|
|
997
|
+
|
|
998
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-get">ngrok.com/docs/api#api-ssh-user-certificates-get</a></p>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
</div>
|
|
1002
|
+
</div>
|
|
1003
|
+
<div class="tags">
|
|
1004
|
+
<p class="tag_title">Parameters:</p>
|
|
1005
|
+
<ul class="param">
|
|
1006
|
+
|
|
1007
|
+
<li>
|
|
1008
|
+
|
|
1009
|
+
<span class='name'>id</span>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
—
|
|
1019
|
+
<div class='inline'>
|
|
1020
|
+
<p>a resource identifier</p>
|
|
1021
|
+
</div>
|
|
1022
|
+
|
|
1023
|
+
</li>
|
|
1024
|
+
|
|
1025
|
+
</ul>
|
|
1026
|
+
|
|
1027
|
+
<p class="tag_title">Returns:</p>
|
|
1028
|
+
<ul class="return">
|
|
1029
|
+
|
|
1030
|
+
<li>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>)</span>
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
—
|
|
1038
|
+
<div class='inline'>
|
|
1039
|
+
<p>result from the API request</p>
|
|
1040
|
+
</div>
|
|
1041
|
+
|
|
1042
|
+
</li>
|
|
1043
|
+
|
|
1044
|
+
</ul>
|
|
1045
|
+
|
|
1046
|
+
</div><table class="source_code">
|
|
1047
|
+
<tr>
|
|
1048
|
+
<td>
|
|
1049
|
+
<pre class="lines">
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
94
|
|
1053
|
+
95
|
|
1054
|
+
96
|
|
1055
|
+
97
|
|
1056
|
+
98
|
|
1057
|
+
99
|
|
1058
|
+
100
|
|
1059
|
+
101
|
|
1060
|
+
102</pre>
|
|
1061
|
+
</td>
|
|
1062
|
+
<td>
|
|
1063
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 94</span>
|
|
1064
|
+
|
|
1065
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1066
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1067
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1068
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1069
|
+
<span class='rbrace'>}</span>
|
|
1070
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1071
|
+
<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>
|
|
1072
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#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>
|
|
1073
|
+
<span class='kw'>end</span></pre>
|
|
1074
|
+
</td>
|
|
1075
|
+
</tr>
|
|
1076
|
+
</table>
|
|
1077
|
+
</div>
|
|
1078
|
+
|
|
1079
|
+
<div class="method_details ">
|
|
1080
|
+
<h3 class="signature " id="get!-instance_method">
|
|
1081
|
+
|
|
1082
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
</h3><div class="docstring">
|
|
1089
|
+
<div class="discussion">
|
|
1090
|
+
|
|
1091
|
+
<p>Get detailed information about an SSH User Certficate Throws an exception if API error.</p>
|
|
1092
|
+
|
|
1093
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-get">ngrok.com/docs/api#api-ssh-user-certificates-get</a></p>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</div>
|
|
1097
|
+
</div>
|
|
1098
|
+
<div class="tags">
|
|
1099
|
+
<p class="tag_title">Parameters:</p>
|
|
1100
|
+
<ul class="param">
|
|
1101
|
+
|
|
1102
|
+
<li>
|
|
1103
|
+
|
|
1104
|
+
<span class='name'>id</span>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
—
|
|
1114
|
+
<div class='inline'>
|
|
1115
|
+
<p>a resource identifier</p>
|
|
1116
|
+
</div>
|
|
1117
|
+
|
|
1118
|
+
</li>
|
|
1119
|
+
|
|
1120
|
+
</ul>
|
|
1121
|
+
|
|
1122
|
+
<p class="tag_title">Returns:</p>
|
|
1123
|
+
<ul class="return">
|
|
1124
|
+
|
|
1125
|
+
<li>
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>)</span>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
—
|
|
1133
|
+
<div class='inline'>
|
|
1134
|
+
<p>result from the API request</p>
|
|
1135
|
+
</div>
|
|
1136
|
+
|
|
1137
|
+
</li>
|
|
1138
|
+
|
|
1139
|
+
</ul>
|
|
1140
|
+
|
|
1141
|
+
</div><table class="source_code">
|
|
1142
|
+
<tr>
|
|
1143
|
+
<td>
|
|
1144
|
+
<pre class="lines">
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
112
|
|
1148
|
+
113
|
|
1149
|
+
114
|
|
1150
|
+
115
|
|
1151
|
+
116
|
|
1152
|
+
117
|
|
1153
|
+
118
|
|
1154
|
+
119
|
|
1155
|
+
120</pre>
|
|
1156
|
+
</td>
|
|
1157
|
+
<td>
|
|
1158
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 112</span>
|
|
1159
|
+
|
|
1160
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1161
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1162
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1163
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1164
|
+
<span class='rbrace'>}</span>
|
|
1165
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1166
|
+
<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>
|
|
1167
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#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>
|
|
1168
|
+
<span class='kw'>end</span></pre>
|
|
1169
|
+
</td>
|
|
1170
|
+
</tr>
|
|
1171
|
+
</table>
|
|
1172
|
+
</div>
|
|
1173
|
+
|
|
1174
|
+
<div class="method_details ">
|
|
1175
|
+
<h3 class="signature " id="list-instance_method">
|
|
1176
|
+
|
|
1177
|
+
#<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>
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
</h3><div class="docstring">
|
|
1184
|
+
<div class="discussion">
|
|
1185
|
+
|
|
1186
|
+
<p>List all SSH User Certificates issued on this account</p>
|
|
1187
|
+
|
|
1188
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">ngrok.com/docs/api#api-ssh-user-certificates-list</a></p>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
</div>
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="tags">
|
|
1194
|
+
<p class="tag_title">Parameters:</p>
|
|
1195
|
+
<ul class="param">
|
|
1196
|
+
|
|
1197
|
+
<li>
|
|
1198
|
+
|
|
1199
|
+
<span class='name'>before_id</span>
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
</li>
|
|
1209
|
+
|
|
1210
|
+
<li>
|
|
1211
|
+
|
|
1212
|
+
<span class='name'>limit</span>
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
</li>
|
|
1222
|
+
|
|
1223
|
+
<li>
|
|
1224
|
+
|
|
1225
|
+
<span class='name'>url</span>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
—
|
|
1235
|
+
<div class='inline'>
|
|
1236
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1237
|
+
</div>
|
|
1238
|
+
|
|
1239
|
+
</li>
|
|
1240
|
+
|
|
1241
|
+
</ul>
|
|
1242
|
+
|
|
1243
|
+
<p class="tag_title">Returns:</p>
|
|
1244
|
+
<ul class="return">
|
|
1245
|
+
|
|
1246
|
+
<li>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<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>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
—
|
|
1254
|
+
<div class='inline'>
|
|
1255
|
+
<p>result from the API request</p>
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
</li>
|
|
1259
|
+
|
|
1260
|
+
</ul>
|
|
1261
|
+
|
|
1262
|
+
</div><table class="source_code">
|
|
1263
|
+
<tr>
|
|
1264
|
+
<td>
|
|
1265
|
+
<pre class="lines">
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
131
|
|
1269
|
+
132
|
|
1270
|
+
133
|
|
1271
|
+
134
|
|
1272
|
+
135
|
|
1273
|
+
136
|
|
1274
|
+
137
|
|
1275
|
+
138
|
|
1276
|
+
139
|
|
1277
|
+
140
|
|
1278
|
+
141
|
|
1279
|
+
142
|
|
1280
|
+
143
|
|
1281
|
+
144
|
|
1282
|
+
145
|
|
1283
|
+
146</pre>
|
|
1284
|
+
</td>
|
|
1285
|
+
<td>
|
|
1286
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 131</span>
|
|
1287
|
+
|
|
1288
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1289
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1290
|
+
<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>
|
|
1291
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1292
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1293
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1294
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span>
|
|
1295
|
+
<span class='rparen'>)</span>
|
|
1296
|
+
|
|
1297
|
+
<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>
|
|
1298
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1299
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1300
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1301
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span>
|
|
1302
|
+
<span class='rparen'>)</span>
|
|
1303
|
+
<span class='kw'>end</span></pre>
|
|
1304
|
+
</td>
|
|
1305
|
+
</tr>
|
|
1306
|
+
</table>
|
|
1307
|
+
</div>
|
|
1308
|
+
|
|
1309
|
+
<div class="method_details ">
|
|
1310
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1311
|
+
|
|
1312
|
+
#<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>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
</h3><div class="docstring">
|
|
1319
|
+
<div class="discussion">
|
|
1320
|
+
|
|
1321
|
+
<p>List all SSH User Certificates issued on this account Throws an exception if API error.</p>
|
|
1322
|
+
|
|
1323
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-list">ngrok.com/docs/api#api-ssh-user-certificates-list</a></p>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
</div>
|
|
1327
|
+
</div>
|
|
1328
|
+
<div class="tags">
|
|
1329
|
+
<p class="tag_title">Parameters:</p>
|
|
1330
|
+
<ul class="param">
|
|
1331
|
+
|
|
1332
|
+
<li>
|
|
1333
|
+
|
|
1334
|
+
<span class='name'>before_id</span>
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
</li>
|
|
1344
|
+
|
|
1345
|
+
<li>
|
|
1346
|
+
|
|
1347
|
+
<span class='name'>limit</span>
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
</li>
|
|
1357
|
+
|
|
1358
|
+
<li>
|
|
1359
|
+
|
|
1360
|
+
<span class='name'>url</span>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
—
|
|
1370
|
+
<div class='inline'>
|
|
1371
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1372
|
+
</div>
|
|
1373
|
+
|
|
1374
|
+
</li>
|
|
1375
|
+
|
|
1376
|
+
</ul>
|
|
1377
|
+
|
|
1378
|
+
<p class="tag_title">Returns:</p>
|
|
1379
|
+
<ul class="return">
|
|
1380
|
+
|
|
1381
|
+
<li>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<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>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
—
|
|
1389
|
+
<div class='inline'>
|
|
1390
|
+
<p>result from the API request</p>
|
|
1391
|
+
</div>
|
|
1392
|
+
|
|
1393
|
+
</li>
|
|
1394
|
+
|
|
1395
|
+
</ul>
|
|
1396
|
+
|
|
1397
|
+
</div><table class="source_code">
|
|
1398
|
+
<tr>
|
|
1399
|
+
<td>
|
|
1400
|
+
<pre class="lines">
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
158
|
|
1404
|
+
159
|
|
1405
|
+
160
|
|
1406
|
+
161
|
|
1407
|
+
162
|
|
1408
|
+
163
|
|
1409
|
+
164
|
|
1410
|
+
165
|
|
1411
|
+
166
|
|
1412
|
+
167
|
|
1413
|
+
168
|
|
1414
|
+
169
|
|
1415
|
+
170
|
|
1416
|
+
171
|
|
1417
|
+
172
|
|
1418
|
+
173
|
|
1419
|
+
174
|
|
1420
|
+
175</pre>
|
|
1421
|
+
</td>
|
|
1422
|
+
<td>
|
|
1423
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 158</span>
|
|
1424
|
+
|
|
1425
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1426
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1427
|
+
<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>
|
|
1428
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1429
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1430
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1431
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1432
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::PATH (constant)">PATH</a></span></span>
|
|
1433
|
+
<span class='rparen'>)</span>
|
|
1434
|
+
|
|
1435
|
+
<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>
|
|
1436
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1437
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1438
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHUserCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1439
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='comma'>,</span>
|
|
1440
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1441
|
+
<span class='rparen'>)</span>
|
|
1442
|
+
<span class='kw'>end</span></pre>
|
|
1443
|
+
</td>
|
|
1444
|
+
</tr>
|
|
1445
|
+
</table>
|
|
1446
|
+
</div>
|
|
1447
|
+
|
|
1448
|
+
<div class="method_details ">
|
|
1449
|
+
<h3 class="signature " id="update-instance_method">
|
|
1450
|
+
|
|
1451
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
</h3><div class="docstring">
|
|
1458
|
+
<div class="discussion">
|
|
1459
|
+
|
|
1460
|
+
<p>Update an SSH User Certificate</p>
|
|
1461
|
+
|
|
1462
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-update">ngrok.com/docs/api#api-ssh-user-certificates-update</a></p>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
</div>
|
|
1466
|
+
</div>
|
|
1467
|
+
<div class="tags">
|
|
1468
|
+
<p class="tag_title">Parameters:</p>
|
|
1469
|
+
<ul class="param">
|
|
1470
|
+
|
|
1471
|
+
<li>
|
|
1472
|
+
|
|
1473
|
+
<span class='name'>id</span>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
</li>
|
|
1483
|
+
|
|
1484
|
+
<li>
|
|
1485
|
+
|
|
1486
|
+
<span class='name'>description</span>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
—
|
|
1496
|
+
<div class='inline'>
|
|
1497
|
+
<p>human-readable description of this SSH User Certificate. optional, max 255 bytes.</p>
|
|
1498
|
+
</div>
|
|
1499
|
+
|
|
1500
|
+
</li>
|
|
1501
|
+
|
|
1502
|
+
<li>
|
|
1503
|
+
|
|
1504
|
+
<span class='name'>metadata</span>
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
—
|
|
1514
|
+
<div class='inline'>
|
|
1515
|
+
<p>arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p>
|
|
1516
|
+
</div>
|
|
1517
|
+
|
|
1518
|
+
</li>
|
|
1519
|
+
|
|
1520
|
+
</ul>
|
|
1521
|
+
|
|
1522
|
+
<p class="tag_title">Returns:</p>
|
|
1523
|
+
<ul class="return">
|
|
1524
|
+
|
|
1525
|
+
<li>
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>)</span>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
—
|
|
1533
|
+
<div class='inline'>
|
|
1534
|
+
<p>result from the API request</p>
|
|
1535
|
+
</div>
|
|
1536
|
+
|
|
1537
|
+
</li>
|
|
1538
|
+
|
|
1539
|
+
</ul>
|
|
1540
|
+
|
|
1541
|
+
</div><table class="source_code">
|
|
1542
|
+
<tr>
|
|
1543
|
+
<td>
|
|
1544
|
+
<pre class="lines">
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
186
|
|
1548
|
+
187
|
|
1549
|
+
188
|
|
1550
|
+
189
|
|
1551
|
+
190
|
|
1552
|
+
191
|
|
1553
|
+
192
|
|
1554
|
+
193
|
|
1555
|
+
194
|
|
1556
|
+
195
|
|
1557
|
+
196</pre>
|
|
1558
|
+
</td>
|
|
1559
|
+
<td>
|
|
1560
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 186</span>
|
|
1561
|
+
|
|
1562
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1563
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1564
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1565
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1566
|
+
<span class='rbrace'>}</span>
|
|
1567
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1568
|
+
<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>
|
|
1569
|
+
<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>
|
|
1570
|
+
<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>
|
|
1571
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#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>
|
|
1572
|
+
<span class='kw'>end</span></pre>
|
|
1573
|
+
</td>
|
|
1574
|
+
</tr>
|
|
1575
|
+
</table>
|
|
1576
|
+
</div>
|
|
1577
|
+
|
|
1578
|
+
<div class="method_details ">
|
|
1579
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1580
|
+
|
|
1581
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
</h3><div class="docstring">
|
|
1588
|
+
<div class="discussion">
|
|
1589
|
+
|
|
1590
|
+
<p>Update an SSH User Certificate Throws an exception if API error.</p>
|
|
1591
|
+
|
|
1592
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-user-certificates-update">ngrok.com/docs/api#api-ssh-user-certificates-update</a></p>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
</div>
|
|
1596
|
+
</div>
|
|
1597
|
+
<div class="tags">
|
|
1598
|
+
<p class="tag_title">Parameters:</p>
|
|
1599
|
+
<ul class="param">
|
|
1600
|
+
|
|
1601
|
+
<li>
|
|
1602
|
+
|
|
1603
|
+
<span class='name'>id</span>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
</li>
|
|
1613
|
+
|
|
1614
|
+
<li>
|
|
1615
|
+
|
|
1616
|
+
<span class='name'>description</span>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
—
|
|
1626
|
+
<div class='inline'>
|
|
1627
|
+
<p>human-readable description of this SSH User Certificate. optional, max 255 bytes.</p>
|
|
1628
|
+
</div>
|
|
1629
|
+
|
|
1630
|
+
</li>
|
|
1631
|
+
|
|
1632
|
+
<li>
|
|
1633
|
+
|
|
1634
|
+
<span class='name'>metadata</span>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
—
|
|
1644
|
+
<div class='inline'>
|
|
1645
|
+
<p>arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.</p>
|
|
1646
|
+
</div>
|
|
1647
|
+
|
|
1648
|
+
</li>
|
|
1649
|
+
|
|
1650
|
+
</ul>
|
|
1651
|
+
|
|
1652
|
+
<p class="tag_title">Returns:</p>
|
|
1653
|
+
<ul class="return">
|
|
1654
|
+
|
|
1655
|
+
<li>
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">NgrokAPI::Models::SSHUserCertificate</a></span></tt>)</span>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
—
|
|
1663
|
+
<div class='inline'>
|
|
1664
|
+
<p>result from the API request</p>
|
|
1665
|
+
</div>
|
|
1666
|
+
|
|
1667
|
+
</li>
|
|
1668
|
+
|
|
1669
|
+
</ul>
|
|
1670
|
+
|
|
1671
|
+
</div><table class="source_code">
|
|
1672
|
+
<tr>
|
|
1673
|
+
<td>
|
|
1674
|
+
<pre class="lines">
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
208
|
|
1678
|
+
209
|
|
1679
|
+
210
|
|
1680
|
+
211
|
|
1681
|
+
212
|
|
1682
|
+
213
|
|
1683
|
+
214
|
|
1684
|
+
215
|
|
1685
|
+
216
|
|
1686
|
+
217
|
|
1687
|
+
218</pre>
|
|
1688
|
+
</td>
|
|
1689
|
+
<td>
|
|
1690
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_user_certificates_client.rb', line 208</span>
|
|
1691
|
+
|
|
1692
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1693
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_user_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1694
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1695
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1696
|
+
<span class='rbrace'>}</span>
|
|
1697
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1698
|
+
<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>
|
|
1699
|
+
<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>
|
|
1700
|
+
<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>
|
|
1701
|
+
<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/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHUserCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHUserCertificate#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>
|
|
1702
|
+
<span class='kw'>end</span></pre>
|
|
1703
|
+
</td>
|
|
1704
|
+
</tr>
|
|
1705
|
+
</table>
|
|
1706
|
+
</div>
|
|
1707
|
+
|
|
1708
|
+
</div>
|
|
1709
|
+
|
|
1710
|
+
</div>
|
|
1711
|
+
|
|
1712
|
+
<div id="footer">
|
|
1713
|
+
Generated on Thu Dec 2 18:48:57 2021 by
|
|
1714
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1715
|
+
0.9.27 (ruby-3.0.1).
|
|
1716
|
+
</div>
|
|
1717
|
+
|
|
1718
|
+
</div>
|
|
1719
|
+
</body>
|
|
1720
|
+
</html>
|