ngrok-api 0.18.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 -61
- 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 +208 -65
- data/doc/NgrokAPI/Models/APIKey.html +220 -90
- data/doc/NgrokAPI/Models/AWSAuth.html +113 -61
- data/doc/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/doc/NgrokAPI/Models/AWSRole.html +101 -49
- data/doc/NgrokAPI/Models/AbuseReport.html +165 -109
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/doc/NgrokAPI/Models/AgentIngress.html +365 -155
- 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 +223 -167
- data/doc/NgrokAPI/Models/Credential.html +225 -95
- data/doc/NgrokAPI/Models/Endpoint.html +215 -159
- data/doc/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/doc/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/doc/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/doc/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/doc/NgrokAPI/Models/EventDestination.html +178 -122
- data/doc/NgrokAPI/Models/EventSource.html +136 -80
- data/doc/NgrokAPI/Models/EventSourceList.html +112 -56
- data/doc/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/doc/NgrokAPI/Models/EventSubscription.html +178 -122
- data/doc/NgrokAPI/Models/EventTarget.html +206 -80
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/doc/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/doc/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/doc/NgrokAPI/Models/IPPolicy.html +178 -122
- data/doc/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/doc/NgrokAPI/Models/IPRestriction.html +190 -134
- data/doc/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/doc/NgrokAPI/Models/Listable.html +130 -130
- data/doc/NgrokAPI/Models/Location.html +817 -0
- data/doc/NgrokAPI/Models/Ref.html +119 -63
- data/doc/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/doc/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/doc/NgrokAPI/Models/SSHCredential.html +232 -102
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/doc/NgrokAPI/Models/TCPEdge.html +204 -148
- data/doc/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/doc/NgrokAPI/Models/TLSEdge.html +216 -160
- data/doc/NgrokAPI/Models/Tunnel.html +205 -149
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/doc/NgrokAPI/Models/TunnelSession.html +193 -137
- data/doc/NgrokAPI/Models/UserAgent.html +965 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +53 -53
- data/doc/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/doc/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/doc/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/doc/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/doc/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- 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 +55 -51
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -51
- data/doc/method_list.html +4383 -2175
- 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 +208 -65
- data/docs/NgrokAPI/Models/APIKey.html +220 -90
- data/docs/NgrokAPI/Models/AWSAuth.html +113 -61
- data/docs/NgrokAPI/Models/AWSCredentials.html +120 -68
- data/docs/NgrokAPI/Models/AWSRole.html +101 -49
- data/docs/NgrokAPI/Models/AbuseReport.html +165 -109
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +113 -61
- data/docs/NgrokAPI/Models/AgentIngress.html +365 -155
- 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 +223 -167
- data/docs/NgrokAPI/Models/Credential.html +225 -95
- data/docs/NgrokAPI/Models/Endpoint.html +215 -159
- data/docs/NgrokAPI/Models/EndpointBackend.html +120 -68
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +147 -95
- data/docs/NgrokAPI/Models/EndpointCompression.html +108 -56
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +120 -68
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +120 -68
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +120 -68
- data/docs/NgrokAPI/Models/EndpointOAuth.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +166 -114
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +149 -97
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +410 -62
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +891 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +183 -131
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +125 -73
- data/docs/NgrokAPI/Models/EndpointSAML.html +244 -176
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +197 -141
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +125 -73
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +120 -68
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +125 -73
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +108 -56
- data/docs/NgrokAPI/Models/EventDestination.html +178 -122
- data/docs/NgrokAPI/Models/EventSource.html +136 -80
- data/docs/NgrokAPI/Models/EventSourceList.html +112 -56
- data/docs/NgrokAPI/Models/EventSourceReplace.html +125 -73
- data/docs/NgrokAPI/Models/EventSubscription.html +178 -122
- data/docs/NgrokAPI/Models/EventTarget.html +206 -80
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +817 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +120 -68
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +113 -61
- data/docs/NgrokAPI/Models/FailoverBackend.html +186 -130
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +202 -146
- data/docs/NgrokAPI/Models/HTTPSEdge.html +207 -151
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +272 -216
- data/docs/NgrokAPI/Models/IPPolicy.html +178 -122
- data/docs/NgrokAPI/Models/IPPolicyRule.html +201 -145
- data/docs/NgrokAPI/Models/IPRestriction.html +190 -134
- data/docs/NgrokAPI/Models/IdentityProvider.html +669 -0
- data/docs/NgrokAPI/Models/Listable.html +130 -130
- data/docs/NgrokAPI/Models/Location.html +817 -0
- data/docs/NgrokAPI/Models/Ref.html +119 -63
- data/docs/NgrokAPI/Models/ReservedAddr.html +189 -133
- data/docs/NgrokAPI/Models/ReservedDomain.html +231 -175
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +130 -78
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +120 -68
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +120 -68
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +197 -141
- data/docs/NgrokAPI/Models/SSHCredential.html +232 -102
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +226 -170
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +240 -184
- data/docs/NgrokAPI/Models/TCPEdge.html +204 -148
- data/docs/NgrokAPI/Models/TLSCertificate.html +279 -223
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +120 -68
- data/docs/NgrokAPI/Models/TLSEdge.html +216 -160
- data/docs/NgrokAPI/Models/Tunnel.html +205 -149
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +191 -135
- data/docs/NgrokAPI/Models/TunnelSession.html +193 -137
- data/docs/NgrokAPI/Models/UserAgent.html +965 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +186 -130
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +53 -53
- data/docs/NgrokAPI/Services/APIKeysClient.html +302 -127
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +176 -39
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +366 -133
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +1131 -0
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +1131 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +276 -123
- data/docs/NgrokAPI/Services/CredentialsClient.html +328 -133
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +528 -113
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +319 -129
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +353 -133
- data/docs/NgrokAPI/Services/EndpointsClient.html +22 -26
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +302 -127
- data/docs/NgrokAPI/Services/EventSourcesClient.html +244 -105
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +302 -127
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +322 -129
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +258 -123
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +317 -130
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +318 -127
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +278 -123
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +388 -171
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +318 -123
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +345 -132
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +354 -123
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +397 -126
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +296 -125
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +282 -127
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +22 -26
- data/docs/NgrokAPI/Services/TunnelsClient.html +22 -26
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +285 -130
- 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 +55 -51
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -51
- data/docs/method_list.html +4383 -2175
- 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 -131
- data/lib/ngrokapi/models/abuse_report.rb +22 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +13 -7
- data/lib/ngrokapi/models/agent_ingress.rb +33 -16
- 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 +24 -12
- 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 +13 -7
- data/lib/ngrokapi/models/aws_credentials.rb +13 -7
- data/lib/ngrokapi/models/aws_role.rb +12 -6
- data/lib/ngrokapi/models/browser_session.rb +35 -0
- data/lib/ngrokapi/models/certificate_authority.rb +26 -16
- data/lib/ngrokapi/models/credential.rb +25 -13
- data/lib/ngrokapi/models/endpoint.rb +28 -18
- data/lib/ngrokapi/models/endpoint_backend.rb +13 -7
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +17 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +12 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +13 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +13 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +13 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_amazon.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +18 -12
- data/lib/ngrokapi/models/endpoint_o_auth_git_lab.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_linked_in.rb +39 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +16 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +24 -10
- data/lib/ngrokapi/models/endpoint_o_auth_twitch.rb +39 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +20 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +14 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +37 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +26 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +14 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +13 -7
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +14 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +12 -6
- data/lib/ngrokapi/models/event_destination.rb +22 -12
- data/lib/ngrokapi/models/event_source.rb +19 -9
- data/lib/ngrokapi/models/event_source_list.rb +17 -7
- data/lib/ngrokapi/models/event_source_replace.rb +14 -8
- data/lib/ngrokapi/models/event_subscription.rb +22 -12
- data/lib/ngrokapi/models/event_target.rb +18 -10
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +13 -7
- data/lib/ngrokapi/models/event_target_datadog.rb +37 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +13 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +13 -7
- data/lib/ngrokapi/models/failover_backend.rb +22 -12
- data/lib/ngrokapi/models/http_response_backend.rb +23 -13
- data/lib/ngrokapi/models/https_edge.rb +24 -14
- data/lib/ngrokapi/models/https_edge_route.rb +34 -24
- data/lib/ngrokapi/models/identity_provider.rb +33 -0
- data/lib/ngrokapi/models/ip_policy.rb +21 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +23 -13
- data/lib/ngrokapi/models/ip_restriction.rb +23 -13
- data/lib/ngrokapi/models/listable.rb +55 -53
- data/lib/ngrokapi/models/location.rb +37 -0
- data/lib/ngrokapi/models/ref.rb +17 -7
- data/lib/ngrokapi/models/reserved_addr.rb +23 -13
- data/lib/ngrokapi/models/reserved_domain.rb +29 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +15 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +13 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +13 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +22 -12
- data/lib/ngrokapi/models/ssh_credential.rb +25 -13
- data/lib/ngrokapi/models/ssh_host_certificate.rb +27 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +29 -19
- data/lib/ngrokapi/models/tcp_edge.rb +23 -13
- data/lib/ngrokapi/models/tls_certificate.rb +36 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +13 -7
- data/lib/ngrokapi/models/tls_edge.rb +25 -15
- data/lib/ngrokapi/models/tunnel.rb +26 -16
- data/lib/ngrokapi/models/tunnel_group_backend.rb +23 -13
- data/lib/ngrokapi/models/tunnel_session.rb +25 -15
- data/lib/ngrokapi/models/user_agent.rb +41 -0
- data/lib/ngrokapi/models/weighted_backend.rb +22 -12
- data/lib/ngrokapi/paged_iterator.rb +44 -42
- data/lib/ngrokapi/services/abuse_reports_client.rb +27 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +45 -14
- data/lib/ngrokapi/services/api_keys_client.rb +37 -12
- 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 +33 -11
- data/lib/ngrokapi/services/credentials_client.rb +45 -16
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +8 -8
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +8 -8
- data/lib/ngrokapi/services/edges_https_client.rb +37 -11
- data/lib/ngrokapi/services/edges_https_routes_client.rb +55 -5
- data/lib/ngrokapi/services/edges_tcp_client.rb +37 -11
- data/lib/ngrokapi/services/edges_tls_client.rb +41 -11
- data/lib/ngrokapi/services/endpoints_client.rb +8 -8
- data/lib/ngrokapi/services/event_destinations_client.rb +37 -13
- data/lib/ngrokapi/services/event_sources_client.rb +29 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +35 -11
- data/lib/ngrokapi/services/failover_backends_client.rb +35 -13
- data/lib/ngrokapi/services/http_response_backends_client.rb +34 -11
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/ip_policies_client.rb +32 -11
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
- data/lib/ngrokapi/services/ip_restrictions_client.rb +37 -11
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -11
- data/lib/ngrokapi/services/reserved_domains_client.rb +44 -16
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +37 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +44 -15
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +41 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +48 -14
- data/lib/ngrokapi/services/tcp_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_certificates_client.rb +37 -13
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb +8 -8
- data/lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb +8 -8
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +35 -13
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +8 -8
- data/lib/ngrokapi/services/tunnels_client.rb +8 -8
- data/lib/ngrokapi/services/weighted_backends_client.rb +38 -16
- 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 +4 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +4 -2
- 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 +8 -3
- data/spec/ngrokapi/models/api_key_spec.rb +4 -2
- 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 +4 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +4 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +4 -2
- data/spec/ngrokapi/models/browser_session_spec.rb +23 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/credential_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_amazon_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_lab_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_linked_in_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_o_auth_twitch_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +4 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +4 -2
- data/spec/ngrokapi/models/event_destination_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +4 -2
- data/spec/ngrokapi/models/event_source_spec.rb +4 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_datadog_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +4 -2
- data/spec/ngrokapi/models/event_target_spec.rb +4 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/http_response_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_route_spec.rb +4 -2
- data/spec/ngrokapi/models/https_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/identity_provider_spec.rb +23 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +4 -2
- 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 +4 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +4 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +4 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_session_spec.rb +4 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +4 -2
- data/spec/ngrokapi/models/user_agent_spec.rb +23 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +4 -2
- data/spec/ngrokapi/paged_iterator_spec.rb +86 -84
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +21 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +34 -3
- data/spec/ngrokapi/services/api_keys_client_spec.rb +28 -1
- 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 +23 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +30 -1
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_circuit_breaker_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_compression_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_o_auth_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_oidc_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_request_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_response_headers_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_saml_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_webhook_verification_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/edges_https_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +49 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +27 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +31 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +2 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +26 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +23 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +23 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +27 -0
- data/spec/ngrokapi/services/https_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/https_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +22 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +27 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +24 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +38 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +27 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +32 -1
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +31 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +35 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tcp_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +25 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +4 -4
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +23 -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 +23 -0
- data/spec/spec_helper.rb +94 -2
- metadata +68 -4
- data/doc/README +0 -94
- data/docs/README +0 -94
@@ -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,31 @@
|
|
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
|
+
|
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_credential from an uploaded public SSH key.</p>
|
226
|
+
</div></span>
|
227
|
+
|
228
|
+
</li>
|
229
|
+
|
230
|
+
|
231
|
+
<li class="public ">
|
232
|
+
<span class="summary_signature">
|
233
|
+
|
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>
|
211
235
|
|
212
236
|
|
213
237
|
|
@@ -478,12 +502,12 @@
|
|
478
502
|
<pre class="lines">
|
479
503
|
|
480
504
|
|
481
|
-
|
482
|
-
|
483
|
-
|
505
|
+
20
|
506
|
+
21
|
507
|
+
22</pre>
|
484
508
|
</td>
|
485
509
|
<td>
|
486
|
-
<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>
|
487
511
|
|
488
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>
|
489
513
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
@@ -526,12 +550,12 @@
|
|
526
550
|
<pre class="lines">
|
527
551
|
|
528
552
|
|
529
|
-
|
530
|
-
|
531
|
-
|
553
|
+
18
|
554
|
+
19
|
555
|
+
20</pre>
|
532
556
|
</td>
|
533
557
|
<td>
|
534
|
-
<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>
|
535
559
|
|
536
560
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
537
561
|
<span class='ivar'>@client</span>
|
@@ -551,7 +575,7 @@
|
|
551
575
|
<div class="method_details first">
|
552
576
|
<h3 class="signature first" id="create-instance_method">
|
553
577
|
|
554
|
-
#<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>
|
555
579
|
|
556
580
|
|
557
581
|
|
@@ -620,7 +644,7 @@
|
|
620
644
|
|
621
645
|
—
|
622
646
|
<div class='inline'>
|
623
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and
|
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>
|
624
648
|
</div>
|
625
649
|
|
626
650
|
</li>
|
@@ -637,6 +661,24 @@
|
|
637
661
|
—
|
638
662
|
<div class='inline'>
|
639
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>
|
640
682
|
</div>
|
641
683
|
|
642
684
|
</li>
|
@@ -668,9 +710,6 @@
|
|
668
710
|
<pre class="lines">
|
669
711
|
|
670
712
|
|
671
|
-
33
|
672
|
-
34
|
673
|
-
35
|
674
713
|
36
|
675
714
|
37
|
676
715
|
38
|
@@ -679,12 +718,16 @@
|
|
679
718
|
41
|
680
719
|
42
|
681
720
|
43
|
682
|
-
44
|
721
|
+
44
|
722
|
+
45
|
723
|
+
46
|
724
|
+
47
|
725
|
+
48</pre>
|
683
726
|
</td>
|
684
727
|
<td>
|
685
|
-
<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>
|
686
729
|
|
687
|
-
<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>
|
688
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>
|
689
732
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
690
733
|
<span class='rbrace'>}</span>
|
@@ -693,8 +736,182 @@
|
|
693
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>
|
694
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>
|
695
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>
|
696
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>
|
697
|
-
<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'>
|
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>
|
742
|
+
<span class='kw'>end</span></pre>
|
743
|
+
</td>
|
744
|
+
</tr>
|
745
|
+
</table>
|
746
|
+
</div>
|
747
|
+
|
748
|
+
<div class="method_details ">
|
749
|
+
<h3 class="signature " id="create!-instance_method">
|
750
|
+
|
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>
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
</h3><div class="docstring">
|
758
|
+
<div class="discussion">
|
759
|
+
|
760
|
+
<p>Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway. Throws an exception if API error.</p>
|
761
|
+
|
762
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-credentials-create">ngrok.com/docs/api#api-ssh-credentials-create</a></p>
|
763
|
+
|
764
|
+
|
765
|
+
</div>
|
766
|
+
</div>
|
767
|
+
<div class="tags">
|
768
|
+
<p class="tag_title">Parameters:</p>
|
769
|
+
<ul class="param">
|
770
|
+
|
771
|
+
<li>
|
772
|
+
|
773
|
+
<span class='name'>description</span>
|
774
|
+
|
775
|
+
|
776
|
+
<span class='type'>(<tt>string</tt>)</span>
|
777
|
+
|
778
|
+
|
779
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
780
|
+
|
781
|
+
|
782
|
+
—
|
783
|
+
<div class='inline'>
|
784
|
+
<p>human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.</p>
|
785
|
+
</div>
|
786
|
+
|
787
|
+
</li>
|
788
|
+
|
789
|
+
<li>
|
790
|
+
|
791
|
+
<span class='name'>metadata</span>
|
792
|
+
|
793
|
+
|
794
|
+
<span class='type'>(<tt>string</tt>)</span>
|
795
|
+
|
796
|
+
|
797
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
798
|
+
|
799
|
+
|
800
|
+
—
|
801
|
+
<div class='inline'>
|
802
|
+
<p>arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.</p>
|
803
|
+
</div>
|
804
|
+
|
805
|
+
</li>
|
806
|
+
|
807
|
+
<li>
|
808
|
+
|
809
|
+
<span class='name'>acl</span>
|
810
|
+
|
811
|
+
|
812
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
813
|
+
|
814
|
+
|
815
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
816
|
+
|
817
|
+
|
818
|
+
—
|
819
|
+
<div class='inline'>
|
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>
|
821
|
+
</div>
|
822
|
+
|
823
|
+
</li>
|
824
|
+
|
825
|
+
<li>
|
826
|
+
|
827
|
+
<span class='name'>public_key</span>
|
828
|
+
|
829
|
+
|
830
|
+
<span class='type'>(<tt>string</tt>)</span>
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
—
|
835
|
+
<div class='inline'>
|
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>
|
855
|
+
</div>
|
856
|
+
|
857
|
+
</li>
|
858
|
+
|
859
|
+
</ul>
|
860
|
+
|
861
|
+
<p class="tag_title">Returns:</p>
|
862
|
+
<ul class="return">
|
863
|
+
|
864
|
+
<li>
|
865
|
+
|
866
|
+
|
867
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">NgrokAPI::Models::SSHCredential</a></span></tt>)</span>
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
—
|
872
|
+
<div class='inline'>
|
873
|
+
<p>result from the API request</p>
|
874
|
+
</div>
|
875
|
+
|
876
|
+
</li>
|
877
|
+
|
878
|
+
</ul>
|
879
|
+
|
880
|
+
</div><table class="source_code">
|
881
|
+
<tr>
|
882
|
+
<td>
|
883
|
+
<pre class="lines">
|
884
|
+
|
885
|
+
|
886
|
+
63
|
887
|
+
64
|
888
|
+
65
|
889
|
+
66
|
890
|
+
67
|
891
|
+
68
|
892
|
+
69
|
893
|
+
70
|
894
|
+
71
|
895
|
+
72
|
896
|
+
73
|
897
|
+
74
|
898
|
+
75</pre>
|
899
|
+
</td>
|
900
|
+
<td>
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 63</span>
|
902
|
+
|
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>
|
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>
|
905
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
906
|
+
<span class='rbrace'>}</span>
|
907
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
908
|
+
<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>
|
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>
|
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>
|
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>
|
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>
|
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>
|
698
915
|
<span class='kw'>end</span></pre>
|
699
916
|
</td>
|
700
917
|
</tr>
|
@@ -769,16 +986,16 @@
|
|
769
986
|
<pre class="lines">
|
770
987
|
|
771
988
|
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
989
|
+
84
|
990
|
+
85
|
991
|
+
86
|
992
|
+
87
|
993
|
+
88
|
994
|
+
89
|
995
|
+
90</pre>
|
779
996
|
</td>
|
780
997
|
<td>
|
781
|
-
<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>
|
782
999
|
|
783
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>
|
784
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>
|
@@ -860,16 +1077,16 @@
|
|
860
1077
|
<pre class="lines">
|
861
1078
|
|
862
1079
|
|
863
|
-
|
864
|
-
|
865
|
-
|
866
|
-
|
867
|
-
|
868
|
-
|
869
|
-
|
1080
|
+
100
|
1081
|
+
101
|
1082
|
+
102
|
1083
|
+
103
|
1084
|
+
104
|
1085
|
+
105
|
1086
|
+
106</pre>
|
870
1087
|
</td>
|
871
1088
|
<td>
|
872
|
-
<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>
|
873
1090
|
|
874
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>
|
875
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>
|
@@ -951,18 +1168,18 @@
|
|
951
1168
|
<pre class="lines">
|
952
1169
|
|
953
1170
|
|
954
|
-
|
955
|
-
|
956
|
-
|
957
|
-
|
958
|
-
|
959
|
-
|
960
|
-
|
961
|
-
|
962
|
-
|
1171
|
+
115
|
1172
|
+
116
|
1173
|
+
117
|
1174
|
+
118
|
1175
|
+
119
|
1176
|
+
120
|
1177
|
+
121
|
1178
|
+
122
|
1179
|
+
123</pre>
|
963
1180
|
</td>
|
964
1181
|
<td>
|
965
|
-
<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>
|
966
1183
|
|
967
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>
|
968
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>
|
@@ -971,7 +1188,7 @@
|
|
971
1188
|
<span class='rbrace'>}</span>
|
972
1189
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
973
1190
|
<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>
|
974
|
-
<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'>
|
1191
|
+
<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>
|
975
1192
|
<span class='kw'>end</span></pre>
|
976
1193
|
</td>
|
977
1194
|
</tr>
|
@@ -1046,18 +1263,18 @@
|
|
1046
1263
|
<pre class="lines">
|
1047
1264
|
|
1048
1265
|
|
1049
|
-
|
1050
|
-
|
1051
|
-
|
1052
|
-
|
1053
|
-
|
1054
|
-
|
1055
|
-
|
1056
|
-
|
1057
|
-
|
1266
|
+
133
|
1267
|
+
134
|
1268
|
+
135
|
1269
|
+
136
|
1270
|
+
137
|
1271
|
+
138
|
1272
|
+
139
|
1273
|
+
140
|
1274
|
+
141</pre>
|
1058
1275
|
</td>
|
1059
1276
|
<td>
|
1060
|
-
<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>
|
1061
1278
|
|
1062
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>
|
1063
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>
|
@@ -1066,7 +1283,7 @@
|
|
1066
1283
|
<span class='rbrace'>}</span>
|
1067
1284
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1068
1285
|
<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>
|
1069
|
-
<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'>
|
1286
|
+
<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>
|
1070
1287
|
<span class='kw'>end</span></pre>
|
1071
1288
|
</td>
|
1072
1289
|
</tr>
|
@@ -1167,28 +1384,26 @@
|
|
1167
1384
|
<pre class="lines">
|
1168
1385
|
|
1169
1386
|
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1185
|
-
136</pre>
|
1387
|
+
152
|
1388
|
+
153
|
1389
|
+
154
|
1390
|
+
155
|
1391
|
+
156
|
1392
|
+
157
|
1393
|
+
158
|
1394
|
+
159
|
1395
|
+
160
|
1396
|
+
161
|
1397
|
+
162
|
1398
|
+
163
|
1399
|
+
164
|
1400
|
+
165
|
1401
|
+
166</pre>
|
1186
1402
|
</td>
|
1187
1403
|
<td>
|
1188
|
-
<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>
|
1189
1405
|
|
1190
|
-
<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>
|
1191
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
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>
|
1192
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>
|
1193
1408
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1194
1409
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
@@ -1198,7 +1413,7 @@
|
|
1198
1413
|
|
1199
1414
|
<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>
|
1200
1415
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1201
|
-
<span class='label'>
|
1416
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1202
1417
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1203
1418
|
<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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span>
|
1204
1419
|
<span class='rparen'>)</span>
|
@@ -1302,30 +1517,28 @@
|
|
1302
1517
|
<pre class="lines">
|
1303
1518
|
|
1304
1519
|
|
1305
|
-
|
1306
|
-
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1311
|
-
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1315
|
-
|
1316
|
-
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
165</pre>
|
1520
|
+
178
|
1521
|
+
179
|
1522
|
+
180
|
1523
|
+
181
|
1524
|
+
182
|
1525
|
+
183
|
1526
|
+
184
|
1527
|
+
185
|
1528
|
+
186
|
1529
|
+
187
|
1530
|
+
188
|
1531
|
+
189
|
1532
|
+
190
|
1533
|
+
191
|
1534
|
+
192
|
1535
|
+
193
|
1536
|
+
194</pre>
|
1323
1537
|
</td>
|
1324
1538
|
<td>
|
1325
|
-
<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>
|
1326
1540
|
|
1327
|
-
<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>
|
1328
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
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>
|
1329
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>
|
1330
1543
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1331
1544
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
@@ -1336,7 +1549,7 @@
|
|
1336
1549
|
|
1337
1550
|
<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>
|
1338
1551
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1339
|
-
<span class='label'>
|
1552
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1340
1553
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1341
1554
|
<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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='comma'>,</span>
|
1342
1555
|
<span class='label'>danger:</span> <span class='kw'>true</span>
|
@@ -1432,7 +1645,7 @@
|
|
1432
1645
|
|
1433
1646
|
—
|
1434
1647
|
<div class='inline'>
|
1435
|
-
<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>
|
1436
1649
|
</div>
|
1437
1650
|
|
1438
1651
|
</li>
|
@@ -1464,21 +1677,21 @@
|
|
1464
1677
|
<pre class="lines">
|
1465
1678
|
|
1466
1679
|
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
|
1473
|
-
|
1474
|
-
|
1475
|
-
|
1476
|
-
|
1477
|
-
|
1478
|
-
|
1680
|
+
206
|
1681
|
+
207
|
1682
|
+
208
|
1683
|
+
209
|
1684
|
+
210
|
1685
|
+
211
|
1686
|
+
212
|
1687
|
+
213
|
1688
|
+
214
|
1689
|
+
215
|
1690
|
+
216
|
1691
|
+
217</pre>
|
1479
1692
|
</td>
|
1480
1693
|
<td>
|
1481
|
-
<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>
|
1482
1695
|
|
1483
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>
|
1484
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>
|
@@ -1490,7 +1703,7 @@
|
|
1490
1703
|
<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>
|
1491
1704
|
<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>
|
1492
1705
|
<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>
|
1493
|
-
<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'>
|
1706
|
+
<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>
|
1494
1707
|
<span class='kw'>end</span></pre>
|
1495
1708
|
</td>
|
1496
1709
|
</tr>
|
@@ -1582,7 +1795,7 @@
|
|
1582
1795
|
|
1583
1796
|
—
|
1584
1797
|
<div class='inline'>
|
1585
|
-
<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>
|
1586
1799
|
</div>
|
1587
1800
|
|
1588
1801
|
</li>
|
@@ -1614,21 +1827,21 @@
|
|
1614
1827
|
<pre class="lines">
|
1615
1828
|
|
1616
1829
|
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1623
|
-
|
1624
|
-
|
1625
|
-
|
1626
|
-
|
1627
|
-
|
1628
|
-
|
1830
|
+
230
|
1831
|
+
231
|
1832
|
+
232
|
1833
|
+
233
|
1834
|
+
234
|
1835
|
+
235
|
1836
|
+
236
|
1837
|
+
237
|
1838
|
+
238
|
1839
|
+
239
|
1840
|
+
240
|
1841
|
+
241</pre>
|
1629
1842
|
</td>
|
1630
1843
|
<td>
|
1631
|
-
<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>
|
1632
1845
|
|
1633
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>
|
1634
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>
|
@@ -1640,7 +1853,7 @@
|
|
1640
1853
|
<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>
|
1641
1854
|
<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>
|
1642
1855
|
<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>
|
1643
|
-
<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'>
|
1856
|
+
<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>
|
1644
1857
|
<span class='kw'>end</span></pre>
|
1645
1858
|
</td>
|
1646
1859
|
</tr>
|
@@ -1652,9 +1865,9 @@
|
|
1652
1865
|
</div>
|
1653
1866
|
|
1654
1867
|
<div id="footer">
|
1655
|
-
Generated on Thu
|
1656
|
-
<a href="
|
1657
|
-
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).
|
1658
1871
|
</div>
|
1659
1872
|
|
1660
1873
|
</div>
|