ngrok-api 0.19.0 → 0.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +7 -7
- data/.gitignore +15 -13
- data/.rubocop.yml +30 -28
- data/.rubocop_airbnb.yml +4 -2
- data/.simplecov +3 -1
- data/CHANGELOG.md +8 -0
- data/CODE_OF_CONDUCT.md +45 -0
- data/Gemfile +34 -32
- data/Guardfile +18 -16
- data/README.md +94 -88
- data/Rakefile +9 -7
- data/doc/NgrokAPI/Client.html +229 -125
- data/doc/NgrokAPI/Error.html +12 -12
- data/doc/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/doc/NgrokAPI/Errors.html +4 -4
- data/doc/NgrokAPI/HttpClient.html +73 -73
- data/doc/NgrokAPI/Models/APIKey.html +150 -72
- data/doc/NgrokAPI/Models/AWSAuth.html +36 -36
- data/doc/NgrokAPI/Models/AWSCredentials.html +36 -36
- data/doc/NgrokAPI/Models/AWSRole.html +32 -32
- data/doc/NgrokAPI/Models/AbuseReport.html +63 -59
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +36 -36
- data/doc/NgrokAPI/Models/AgentIngress.html +245 -87
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/doc/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/doc/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/doc/NgrokAPI/Models/BrowserSession.html +743 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +93 -89
- data/doc/NgrokAPI/Models/Credential.html +154 -76
- data/doc/NgrokAPI/Models/Endpoint.html +87 -83
- data/doc/NgrokAPI/Models/EndpointBackend.html +36 -36
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
- data/doc/NgrokAPI/Models/EndpointCompression.html +32 -32
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
- data/doc/NgrokAPI/Models/EndpointOAuth.html +56 -56
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +64 -64
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
- data/doc/NgrokAPI/Models/EndpointSAML.html +114 -98
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
- data/doc/NgrokAPI/Models/EventDestination.html +69 -65
- data/doc/NgrokAPI/Models/EventSource.html +51 -47
- data/doc/NgrokAPI/Models/EventSourceList.html +43 -39
- data/doc/NgrokAPI/Models/EventSourceReplace.html +40 -40
- data/doc/NgrokAPI/Models/EventSubscription.html +69 -65
- data/doc/NgrokAPI/Models/EventTarget.html +119 -45
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +36 -36
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +36 -36
- data/doc/NgrokAPI/Models/FailoverBackend.html +73 -69
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
- data/doc/NgrokAPI/Models/HTTPSEdge.html +85 -81
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
- data/doc/NgrokAPI/Models/IPPolicy.html +73 -69
- data/doc/NgrokAPI/Models/IPPolicyRule.html +81 -77
- data/doc/NgrokAPI/Models/IPRestriction.html +73 -69
- data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/doc/NgrokAPI/Models/Listable.html +79 -79
- data/doc/NgrokAPI/Models/Location.html +817 -0
- data/doc/NgrokAPI/Models/Ref.html +43 -39
- data/doc/NgrokAPI/Models/ReservedAddr.html +73 -69
- data/doc/NgrokAPI/Models/ReservedDomain.html +97 -93
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
- data/doc/NgrokAPI/Models/SSHCredential.html +154 -76
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +97 -93
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +105 -101
- data/doc/NgrokAPI/Models/TCPEdge.html +81 -77
- data/doc/NgrokAPI/Models/TLSCertificate.html +133 -129
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
- data/doc/NgrokAPI/Models/TLSEdge.html +89 -85
- data/doc/NgrokAPI/Models/Tunnel.html +79 -75
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
- data/doc/NgrokAPI/Models/TunnelSession.html +75 -71
- data/doc/NgrokAPI/Models/UserAgent.html +965 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +73 -69
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +53 -53
- data/doc/NgrokAPI/Services/APIKeysClient.html +134 -94
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +28 -28
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +184 -104
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +52 -52
- data/doc/NgrokAPI/Services/CredentialsClient.html +139 -99
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +52 -52
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +52 -52
- data/doc/NgrokAPI/Services/EndpointsClient.html +28 -28
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +17 -17
- data/doc/NgrokAPI/Services/EventSourcesClient.html +52 -52
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +52 -52
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
- data/doc/NgrokAPI/Services/TunnelsClient.html +28 -28
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +6 -6
- data/doc/_index.html +139 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +45 -41
- data/doc/frames.html +1 -1
- data/doc/index.html +45 -41
- data/doc/method_list.html +2127 -671
- data/doc/top-level-namespace.html +4 -4
- data/docs/NgrokAPI/Client.html +229 -125
- data/docs/NgrokAPI/Error.html +12 -12
- data/docs/NgrokAPI/Errors/NotFoundError.html +12 -12
- data/docs/NgrokAPI/Errors.html +4 -4
- data/docs/NgrokAPI/HttpClient.html +73 -73
- data/docs/NgrokAPI/Models/APIKey.html +150 -72
- data/docs/NgrokAPI/Models/AWSAuth.html +36 -36
- data/docs/NgrokAPI/Models/AWSCredentials.html +36 -36
- data/docs/NgrokAPI/Models/AWSRole.html +32 -32
- data/docs/NgrokAPI/Models/AbuseReport.html +63 -59
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +36 -36
- data/docs/NgrokAPI/Models/AgentIngress.html +245 -87
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +817 -0
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +669 -0
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +669 -0
- data/docs/NgrokAPI/Models/ApplicationSession.html +1414 -0
- data/docs/NgrokAPI/Models/ApplicationUser.html +1336 -0
- data/docs/NgrokAPI/Models/BrowserSession.html +743 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +93 -89
- data/docs/NgrokAPI/Models/Credential.html +154 -76
- data/docs/NgrokAPI/Models/Endpoint.html +87 -83
- data/docs/NgrokAPI/Models/EndpointBackend.html +36 -36
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +52 -52
- data/docs/NgrokAPI/Models/EndpointCompression.html +32 -32
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +36 -36
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +36 -36
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +36 -36
- data/docs/NgrokAPI/Models/EndpointOAuth.html +56 -56
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +56 -56
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +48 -48
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +345 -49
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +64 -64
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +40 -40
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +40 -40
- data/docs/NgrokAPI/Models/EndpointSAML.html +114 -98
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +79 -75
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +40 -40
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +36 -36
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +40 -40
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +32 -32
- data/docs/NgrokAPI/Models/EventDestination.html +69 -65
- data/docs/NgrokAPI/Models/EventSource.html +51 -47
- data/docs/NgrokAPI/Models/EventSourceList.html +43 -39
- data/docs/NgrokAPI/Models/EventSourceReplace.html +40 -40
- data/docs/NgrokAPI/Models/EventSubscription.html +69 -65
- data/docs/NgrokAPI/Models/EventTarget.html +119 -45
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +36 -36
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +36 -36
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +36 -36
- data/docs/NgrokAPI/Models/FailoverBackend.html +73 -69
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +81 -77
- data/docs/NgrokAPI/Models/HTTPSEdge.html +85 -81
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +127 -123
- data/docs/NgrokAPI/Models/IPPolicy.html +73 -69
- data/docs/NgrokAPI/Models/IPPolicyRule.html +81 -77
- data/docs/NgrokAPI/Models/IPRestriction.html +73 -69
- data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/docs/NgrokAPI/Models/Listable.html +79 -79
- data/docs/NgrokAPI/Models/Location.html +817 -0
- data/docs/NgrokAPI/Models/Ref.html +43 -39
- data/docs/NgrokAPI/Models/ReservedAddr.html +73 -69
- data/docs/NgrokAPI/Models/ReservedDomain.html +97 -93
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +44 -44
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +36 -36
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +36 -36
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +77 -73
- data/docs/NgrokAPI/Models/SSHCredential.html +154 -76
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +97 -93
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +105 -101
- data/docs/NgrokAPI/Models/TCPEdge.html +81 -77
- data/docs/NgrokAPI/Models/TLSCertificate.html +133 -129
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +36 -36
- data/docs/NgrokAPI/Models/TLSEdge.html +89 -85
- data/docs/NgrokAPI/Models/Tunnel.html +79 -75
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +77 -73
- data/docs/NgrokAPI/Models/TunnelSession.html +75 -71
- data/docs/NgrokAPI/Models/UserAgent.html +965 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +73 -69
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +53 -53
- data/docs/NgrokAPI/Services/APIKeysClient.html +134 -94
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +28 -28
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +184 -104
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +52 -52
- data/docs/NgrokAPI/Services/CredentialsClient.html +139 -99
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +52 -52
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +44 -44
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +52 -52
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +52 -52
- data/docs/NgrokAPI/Services/EndpointsClient.html +28 -28
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +17 -17
- data/docs/NgrokAPI/Services/EventSourcesClient.html +52 -52
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +52 -52
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +52 -52
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +58 -62
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +52 -52
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +52 -52
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +90 -86
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +52 -52
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +138 -98
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +52 -52
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +56 -56
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +56 -56
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +36 -36
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +52 -52
- data/docs/NgrokAPI/Services/TunnelsClient.html +28 -28
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +52 -52
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +6 -6
- data/docs/_index.html +139 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +45 -41
- data/docs/frames.html +1 -1
- data/docs/index.html +45 -41
- data/docs/method_list.html +2127 -671
- data/docs/top-level-namespace.html +4 -4
- data/lib/ngrokapi/client.rb +21 -11
- data/lib/ngrokapi/error.rb +2 -0
- data/lib/ngrokapi/errors/not_found_error.rb +2 -0
- data/lib/ngrokapi/http_client.rb +153 -150
- data/lib/ngrokapi/models/abuse_report.rb +7 -1
- data/lib/ngrokapi/models/abuse_report_hostname.rb +2 -0
- data/lib/ngrokapi/models/agent_ingress.rb +17 -4
- data/lib/ngrokapi/models/agent_ingress_cert_job.rb +37 -0
- data/lib/ngrokapi/models/agent_ingress_cert_policy.rb +33 -0
- data/lib/ngrokapi/models/agent_ingress_cert_status.rb +33 -0
- data/lib/ngrokapi/models/api_key.rb +10 -2
- data/lib/ngrokapi/models/application_session.rb +67 -0
- data/lib/ngrokapi/models/application_user.rb +63 -0
- data/lib/ngrokapi/models/aws_auth.rb +2 -0
- data/lib/ngrokapi/models/aws_credentials.rb +2 -0
- data/lib/ngrokapi/models/aws_role.rb +2 -0
- data/lib/ngrokapi/models/browser_session.rb +35 -0
- data/lib/ngrokapi/models/certificate_authority.rb +7 -1
- data/lib/ngrokapi/models/credential.rb +10 -2
- data/lib/ngrokapi/models/endpoint.rb +7 -1
- data/lib/ngrokapi/models/endpoint_backend.rb +2 -0
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +2 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +2 -0
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +2 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +2 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +2 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +11 -1
- data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +2 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +2 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +2 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +16 -4
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +7 -1
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +2 -0
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +2 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +2 -0
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +2 -0
- data/lib/ngrokapi/models/event_destination.rb +7 -1
- data/lib/ngrokapi/models/event_source.rb +7 -1
- data/lib/ngrokapi/models/event_source_list.rb +7 -1
- data/lib/ngrokapi/models/event_source_replace.rb +2 -0
- data/lib/ngrokapi/models/event_subscription.rb +7 -1
- data/lib/ngrokapi/models/event_target.rb +5 -1
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +2 -0
- data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +2 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +2 -0
- data/lib/ngrokapi/models/failover_backend.rb +7 -1
- data/lib/ngrokapi/models/http_response_backend.rb +7 -1
- data/lib/ngrokapi/models/https_edge.rb +7 -1
- data/lib/ngrokapi/models/https_edge_route.rb +7 -1
- data/lib/ngrokapi/models/identity_provider.rb +33 -0
- data/lib/ngrokapi/models/ip_policy.rb +7 -1
- data/lib/ngrokapi/models/ip_policy_rule.rb +7 -1
- data/lib/ngrokapi/models/ip_restriction.rb +7 -1
- data/lib/ngrokapi/models/listable.rb +55 -53
- data/lib/ngrokapi/models/location.rb +37 -0
- data/lib/ngrokapi/models/ref.rb +7 -1
- data/lib/ngrokapi/models/reserved_addr.rb +7 -1
- data/lib/ngrokapi/models/reserved_domain.rb +7 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +2 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +2 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +2 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +7 -1
- data/lib/ngrokapi/models/ssh_credential.rb +10 -2
- data/lib/ngrokapi/models/ssh_host_certificate.rb +7 -1
- data/lib/ngrokapi/models/ssh_user_certificate.rb +7 -1
- data/lib/ngrokapi/models/tcp_edge.rb +7 -1
- data/lib/ngrokapi/models/tls_certificate.rb +7 -1
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +2 -0
- data/lib/ngrokapi/models/tls_edge.rb +7 -1
- data/lib/ngrokapi/models/tunnel.rb +7 -1
- data/lib/ngrokapi/models/tunnel_group_backend.rb +7 -1
- data/lib/ngrokapi/models/tunnel_session.rb +7 -1
- data/lib/ngrokapi/models/user_agent.rb +41 -0
- data/lib/ngrokapi/models/weighted_backend.rb +7 -1
- data/lib/ngrokapi/paged_iterator.rb +44 -42
- data/lib/ngrokapi/services/abuse_reports_client.rb +2 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +14 -4
- data/lib/ngrokapi/services/api_keys_client.rb +8 -2
- data/lib/ngrokapi/services/application_sessions_client.rb +141 -0
- data/lib/ngrokapi/services/application_users_client.rb +141 -0
- data/lib/ngrokapi/services/certificate_authorities_client.rb +2 -0
- data/lib/ngrokapi/services/credentials_client.rb +13 -7
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +2 -0
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +2 -0
- data/lib/ngrokapi/services/edges_https_client.rb +2 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +2 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +2 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +2 -0
- data/lib/ngrokapi/services/endpoints_client.rb +2 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +4 -4
- data/lib/ngrokapi/services/event_sources_client.rb +2 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +2 -0
- data/lib/ngrokapi/services/failover_backends_client.rb +2 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +2 -0
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +2 -0
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +2 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +2 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +4 -2
- data/lib/ngrokapi/services/ip_restrictions_client.rb +2 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +2 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +10 -8
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +2 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +6 -4
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +6 -4
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +2 -0
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +2 -0
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +2 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +2 -0
- data/lib/ngrokapi/services/tunnels_client.rb +2 -0
- data/lib/ngrokapi/services/weighted_backends_client.rb +2 -0
- data/lib/ngrokapi/version.rb +9 -7
- data/lib/ngrokapi.rb +15 -13
- data/ngrok-api.gemspec +29 -27
- data/spec/ngrokapi/client_spec.rb +20 -6
- data/spec/ngrokapi/http_client_spec.rb +77 -75
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +2 -0
- data/spec/ngrokapi/models/agent_ingress_cert_job_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_cert_status_spec.rb +23 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +6 -1
- data/spec/ngrokapi/models/api_key_spec.rb +2 -0
- data/spec/ngrokapi/models/application_session_spec.rb +30 -0
- data/spec/ngrokapi/models/application_user_spec.rb +30 -0
- data/spec/ngrokapi/models/aws_auth_spec.rb +2 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +2 -0
- data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -0
- data/spec/ngrokapi/models/credential_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -0
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +2 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -0
- data/spec/ngrokapi/models/event_source_spec.rb +2 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -0
- data/spec/ngrokapi/models/event_target_spec.rb +2 -0
- data/spec/ngrokapi/models/failover_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +2 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -0
- data/spec/ngrokapi/models/listable_spec.rb +45 -43
- data/spec/ngrokapi/models/location_spec.rb +23 -0
- data/spec/ngrokapi/models/ref_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -0
- data/spec/ngrokapi/models/tls_edge_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +2 -0
- data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +2 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +2 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +14 -4
- data/spec/ngrokapi/services/api_keys_client_spec.rb +10 -2
- data/spec/ngrokapi/services/application_sessions_client_spec.rb +100 -0
- data/spec/ngrokapi/services/application_users_client_spec.rb +100 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +2 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +10 -2
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_https_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +2 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +2 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +2 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +2 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +2 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +10 -4
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +10 -2
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +2 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +2 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +2 -0
- data/spec/spec_helper.rb +94 -2
- metadata +68 -2
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: NgrokAPI::Services::SSHCredentialsClient
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.34
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -207,7 +207,7 @@
|
|
207
207
|
<li class="public ">
|
208
208
|
<span class="summary_signature">
|
209
209
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential </a>
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::SSHCredential </a>
|
211
211
|
|
212
212
|
|
213
213
|
|
@@ -231,7 +231,7 @@
|
|
231
231
|
<li class="public ">
|
232
232
|
<span class="summary_signature">
|
233
233
|
|
234
|
-
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential </a>
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::SSHCredential </a>
|
235
235
|
|
236
236
|
|
237
237
|
|
@@ -502,12 +502,12 @@
|
|
502
502
|
<pre class="lines">
|
503
503
|
|
504
504
|
|
505
|
-
|
506
|
-
|
507
|
-
|
505
|
+
20
|
506
|
+
21
|
507
|
+
22</pre>
|
508
508
|
</td>
|
509
509
|
<td>
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 20</span>
|
511
511
|
|
512
512
|
<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>
|
513
513
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
@@ -550,12 +550,12 @@
|
|
550
550
|
<pre class="lines">
|
551
551
|
|
552
552
|
|
553
|
-
|
554
|
-
|
555
|
-
|
553
|
+
18
|
554
|
+
19
|
555
|
+
20</pre>
|
556
556
|
</td>
|
557
557
|
<td>
|
558
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
558
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 18</span>
|
559
559
|
|
560
560
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
561
561
|
<span class='ivar'>@client</span>
|
@@ -575,7 +575,7 @@
|
|
575
575
|
<div class="method_details first">
|
576
576
|
<h3 class="signature first" id="create-instance_method">
|
577
577
|
|
578
|
-
#<strong>create</strong>(description: "", metadata: "", acl: [], public_key:) ⇒ <tt><span class='object_link'><a href="../Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">NgrokAPI::Models::SSHCredential</a></span></tt>
|
578
|
+
#<strong>create</strong>(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">NgrokAPI::Models::SSHCredential</a></span></tt>
|
579
579
|
|
580
580
|
|
581
581
|
|
@@ -644,7 +644,7 @@
|
|
644
644
|
|
645
645
|
—
|
646
646
|
<div class='inline'>
|
647
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
647
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
648
648
|
</div>
|
649
649
|
|
650
650
|
</li>
|
@@ -661,6 +661,24 @@
|
|
661
661
|
—
|
662
662
|
<div class='inline'>
|
663
663
|
<p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
|
664
|
+
</div>
|
665
|
+
|
666
|
+
</li>
|
667
|
+
|
668
|
+
<li>
|
669
|
+
|
670
|
+
<span class='name'>owner_id</span>
|
671
|
+
|
672
|
+
|
673
|
+
<span class='type'>(<tt>string</tt>)</span>
|
674
|
+
|
675
|
+
|
676
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
677
|
+
|
678
|
+
|
679
|
+
—
|
680
|
+
<div class='inline'>
|
681
|
+
<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
664
682
|
</div>
|
665
683
|
|
666
684
|
</li>
|
@@ -692,9 +710,6 @@
|
|
692
710
|
<pre class="lines">
|
693
711
|
|
694
712
|
|
695
|
-
33
|
696
|
-
34
|
697
|
-
35
|
698
713
|
36
|
699
714
|
37
|
700
715
|
38
|
@@ -703,12 +718,16 @@
|
|
703
718
|
41
|
704
719
|
42
|
705
720
|
43
|
706
|
-
44
|
721
|
+
44
|
722
|
+
45
|
723
|
+
46
|
724
|
+
47
|
725
|
+
48</pre>
|
707
726
|
</td>
|
708
727
|
<td>
|
709
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
728
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 36</span>
|
710
729
|
|
711
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='rparen'>)</span>
|
730
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
712
731
|
<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_credentials</span><span class='tstring_end'>'</span></span>
|
713
732
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
714
733
|
<span class='rbrace'>}</span>
|
@@ -717,6 +736,7 @@
|
|
717
736
|
<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>
|
718
737
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
|
719
738
|
<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>
|
739
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</span>
|
720
740
|
<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>
|
721
741
|
<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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHCredential.html#initialize-instance_method" title="NgrokAPI::Models::SSHCredential#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
722
742
|
<span class='kw'>end</span></pre>
|
@@ -728,7 +748,7 @@
|
|
728
748
|
<div class="method_details ">
|
729
749
|
<h3 class="signature " id="create!-instance_method">
|
730
750
|
|
731
|
-
#<strong>create!</strong>(description: "", metadata: "", acl: [], public_key:) ⇒ <tt><span class='object_link'><a href="../Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">NgrokAPI::Models::SSHCredential</a></span></tt>
|
751
|
+
#<strong>create!</strong>(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">NgrokAPI::Models::SSHCredential</a></span></tt>
|
732
752
|
|
733
753
|
|
734
754
|
|
@@ -797,7 +817,7 @@
|
|
797
817
|
|
798
818
|
—
|
799
819
|
<div class='inline'>
|
800
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
820
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
801
821
|
</div>
|
802
822
|
|
803
823
|
</li>
|
@@ -814,6 +834,24 @@
|
|
814
834
|
—
|
815
835
|
<div class='inline'>
|
816
836
|
<p>the PEM-encoded public key of the SSH keypair that will be used to authenticate</p>
|
837
|
+
</div>
|
838
|
+
|
839
|
+
</li>
|
840
|
+
|
841
|
+
<li>
|
842
|
+
|
843
|
+
<span class='name'>owner_id</span>
|
844
|
+
|
845
|
+
|
846
|
+
<span class='type'>(<tt>string</tt>)</span>
|
847
|
+
|
848
|
+
|
849
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
850
|
+
|
851
|
+
|
852
|
+
—
|
853
|
+
<div class='inline'>
|
854
|
+
<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
|
817
855
|
</div>
|
818
856
|
|
819
857
|
</li>
|
@@ -845,23 +883,24 @@
|
|
845
883
|
<pre class="lines">
|
846
884
|
|
847
885
|
|
848
|
-
58
|
849
|
-
59
|
850
|
-
60
|
851
|
-
61
|
852
|
-
62
|
853
886
|
63
|
854
887
|
64
|
855
888
|
65
|
856
889
|
66
|
857
890
|
67
|
858
891
|
68
|
859
|
-
69
|
892
|
+
69
|
893
|
+
70
|
894
|
+
71
|
895
|
+
72
|
896
|
+
73
|
897
|
+
74
|
898
|
+
75</pre>
|
860
899
|
</td>
|
861
900
|
<td>
|
862
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 63</span>
|
863
902
|
|
864
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</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='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='rparen'>)</span>
|
903
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</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='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
865
904
|
<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_credentials</span><span class='tstring_end'>'</span></span>
|
866
905
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
867
906
|
<span class='rbrace'>}</span>
|
@@ -870,6 +909,7 @@
|
|
870
909
|
<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>
|
871
910
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:acl</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_acl'>acl</span> <span class='kw'>if</span> <span class='id identifier rubyid_acl'>acl</span>
|
872
911
|
<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>
|
912
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:owner_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_owner_id'>owner_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_owner_id'>owner_id</span>
|
873
913
|
<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='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
874
914
|
<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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHCredential.html#initialize-instance_method" title="NgrokAPI::Models::SSHCredential#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
875
915
|
<span class='kw'>end</span></pre>
|
@@ -946,16 +986,16 @@
|
|
946
986
|
<pre class="lines">
|
947
987
|
|
948
988
|
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
|
954
|
-
|
955
|
-
|
989
|
+
84
|
990
|
+
85
|
991
|
+
86
|
992
|
+
87
|
993
|
+
88
|
994
|
+
89
|
995
|
+
90</pre>
|
956
996
|
</td>
|
957
997
|
<td>
|
958
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
998
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 84</span>
|
959
999
|
|
960
1000
|
<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>
|
961
1001
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1037,16 +1077,16 @@
|
|
1037
1077
|
<pre class="lines">
|
1038
1078
|
|
1039
1079
|
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1044
|
-
|
1045
|
-
|
1046
|
-
|
1080
|
+
100
|
1081
|
+
101
|
1082
|
+
102
|
1083
|
+
103
|
1084
|
+
104
|
1085
|
+
105
|
1086
|
+
106</pre>
|
1047
1087
|
</td>
|
1048
1088
|
<td>
|
1049
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1089
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 100</span>
|
1050
1090
|
|
1051
1091
|
<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>
|
1052
1092
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1128,18 +1168,18 @@
|
|
1128
1168
|
<pre class="lines">
|
1129
1169
|
|
1130
1170
|
|
1131
|
-
109
|
1132
|
-
110
|
1133
|
-
111
|
1134
|
-
112
|
1135
|
-
113
|
1136
|
-
114
|
1137
1171
|
115
|
1138
1172
|
116
|
1139
|
-
117
|
1173
|
+
117
|
1174
|
+
118
|
1175
|
+
119
|
1176
|
+
120
|
1177
|
+
121
|
1178
|
+
122
|
1179
|
+
123</pre>
|
1140
1180
|
</td>
|
1141
1181
|
<td>
|
1142
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1182
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 115</span>
|
1143
1183
|
|
1144
1184
|
<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>
|
1145
1185
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1223,18 +1263,18 @@
|
|
1223
1263
|
<pre class="lines">
|
1224
1264
|
|
1225
1265
|
|
1226
|
-
127
|
1227
|
-
128
|
1228
|
-
129
|
1229
|
-
130
|
1230
|
-
131
|
1231
|
-
132
|
1232
1266
|
133
|
1233
1267
|
134
|
1234
|
-
135
|
1268
|
+
135
|
1269
|
+
136
|
1270
|
+
137
|
1271
|
+
138
|
1272
|
+
139
|
1273
|
+
140
|
1274
|
+
141</pre>
|
1235
1275
|
</td>
|
1236
1276
|
<td>
|
1237
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1277
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 133</span>
|
1238
1278
|
|
1239
1279
|
<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>
|
1240
1280
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1344,12 +1384,6 @@
|
|
1344
1384
|
<pre class="lines">
|
1345
1385
|
|
1346
1386
|
|
1347
|
-
146
|
1348
|
-
147
|
1349
|
-
148
|
1350
|
-
149
|
1351
|
-
150
|
1352
|
-
151
|
1353
1387
|
152
|
1354
1388
|
153
|
1355
1389
|
154
|
@@ -1358,10 +1392,16 @@
|
|
1358
1392
|
157
|
1359
1393
|
158
|
1360
1394
|
159
|
1361
|
-
160
|
1395
|
+
160
|
1396
|
+
161
|
1397
|
+
162
|
1398
|
+
163
|
1399
|
+
164
|
1400
|
+
165
|
1401
|
+
166</pre>
|
1362
1402
|
</td>
|
1363
1403
|
<td>
|
1364
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1404
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 152</span>
|
1365
1405
|
|
1366
1406
|
<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> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1367
1407
|
<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>
|
@@ -1477,12 +1517,6 @@
|
|
1477
1517
|
<pre class="lines">
|
1478
1518
|
|
1479
1519
|
|
1480
|
-
172
|
1481
|
-
173
|
1482
|
-
174
|
1483
|
-
175
|
1484
|
-
176
|
1485
|
-
177
|
1486
1520
|
178
|
1487
1521
|
179
|
1488
1522
|
180
|
@@ -1493,10 +1527,16 @@
|
|
1493
1527
|
185
|
1494
1528
|
186
|
1495
1529
|
187
|
1496
|
-
188
|
1530
|
+
188
|
1531
|
+
189
|
1532
|
+
190
|
1533
|
+
191
|
1534
|
+
192
|
1535
|
+
193
|
1536
|
+
194</pre>
|
1497
1537
|
</td>
|
1498
1538
|
<td>
|
1499
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1539
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 178</span>
|
1500
1540
|
|
1501
1541
|
<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> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1502
1542
|
<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>
|
@@ -1605,7 +1645,7 @@
|
|
1605
1645
|
|
1606
1646
|
—
|
1607
1647
|
<div class='inline'>
|
1608
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
1648
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
1609
1649
|
</div>
|
1610
1650
|
|
1611
1651
|
</li>
|
@@ -1637,21 +1677,21 @@
|
|
1637
1677
|
<pre class="lines">
|
1638
1678
|
|
1639
1679
|
|
1640
|
-
200
|
1641
|
-
201
|
1642
|
-
202
|
1643
|
-
203
|
1644
|
-
204
|
1645
|
-
205
|
1646
1680
|
206
|
1647
1681
|
207
|
1648
1682
|
208
|
1649
1683
|
209
|
1650
1684
|
210
|
1651
|
-
211
|
1685
|
+
211
|
1686
|
+
212
|
1687
|
+
213
|
1688
|
+
214
|
1689
|
+
215
|
1690
|
+
216
|
1691
|
+
217</pre>
|
1652
1692
|
</td>
|
1653
1693
|
<td>
|
1654
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1694
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 206</span>
|
1655
1695
|
|
1656
1696
|
<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='comma'>,</span> <span class='label'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1657
1697
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1755,7 +1795,7 @@
|
|
1755
1795
|
|
1756
1796
|
—
|
1757
1797
|
<div class='inline'>
|
1758
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
1798
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
1759
1799
|
</div>
|
1760
1800
|
|
1761
1801
|
</li>
|
@@ -1787,21 +1827,21 @@
|
|
1787
1827
|
<pre class="lines">
|
1788
1828
|
|
1789
1829
|
|
1790
|
-
224
|
1791
|
-
225
|
1792
|
-
226
|
1793
|
-
227
|
1794
|
-
228
|
1795
|
-
229
|
1796
1830
|
230
|
1797
1831
|
231
|
1798
1832
|
232
|
1799
1833
|
233
|
1800
1834
|
234
|
1801
|
-
235
|
1835
|
+
235
|
1836
|
+
236
|
1837
|
+
237
|
1838
|
+
238
|
1839
|
+
239
|
1840
|
+
240
|
1841
|
+
241</pre>
|
1802
1842
|
</td>
|
1803
1843
|
<td>
|
1804
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
1844
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 230</span>
|
1805
1845
|
|
1806
1846
|
<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='comma'>,</span> <span class='label'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1807
1847
|
<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_credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1825,9 +1865,9 @@
|
|
1825
1865
|
</div>
|
1826
1866
|
|
1827
1867
|
<div id="footer">
|
1828
|
-
Generated on
|
1829
|
-
<a href="
|
1830
|
-
0.9.
|
1868
|
+
Generated on Thu Aug 24 20:57:34 2023 by
|
1869
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1870
|
+
0.9.34 (ruby-3.0.6).
|
1831
1871
|
</div>
|
1832
1872
|
|
1833
1873
|
</div>
|