ngrok-api 0.19.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.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::CredentialsClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.34
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
|
|
105
|
+
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
|
|
106
106
|
|
|
107
107
|
<p><a href="https://ngrok.com/docs/api#api-credentials">ngrok.com/docs/api#api-credentials</a></p>
|
|
108
108
|
|
|
@@ -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: []) ⇒ NgrokAPI::Models::Credential </a>
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential </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: []) ⇒ NgrokAPI::Models::Credential </a>
|
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential </a>
|
|
235
235
|
|
|
236
236
|
|
|
237
237
|
|
|
@@ -502,12 +502,12 @@
|
|
|
502
502
|
<pre class="lines">
|
|
503
503
|
|
|
504
504
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
505
|
+
22
|
|
506
|
+
23
|
|
507
|
+
24</pre>
|
|
508
508
|
</td>
|
|
509
509
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 22</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
|
+
20
|
|
554
|
+
21
|
|
555
|
+
22</pre>
|
|
556
556
|
</td>
|
|
557
557
|
<td>
|
|
558
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
558
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 20</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: []) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
578
|
+
#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
579
579
|
|
|
580
580
|
|
|
581
581
|
|
|
@@ -644,7 +644,25 @@
|
|
|
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
|
+
</div>
|
|
649
|
+
|
|
650
|
+
</li>
|
|
651
|
+
|
|
652
|
+
<li>
|
|
653
|
+
|
|
654
|
+
<span class='name'>owner_id</span>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
—
|
|
664
|
+
<div class='inline'>
|
|
665
|
+
<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>
|
|
648
666
|
</div>
|
|
649
667
|
|
|
650
668
|
</li>
|
|
@@ -676,9 +694,6 @@
|
|
|
676
694
|
<pre class="lines">
|
|
677
695
|
|
|
678
696
|
|
|
679
|
-
36
|
|
680
|
-
37
|
|
681
|
-
38
|
|
682
697
|
39
|
|
683
698
|
40
|
|
684
699
|
41
|
|
@@ -686,12 +701,16 @@
|
|
|
686
701
|
43
|
|
687
702
|
44
|
|
688
703
|
45
|
|
689
|
-
46
|
|
704
|
+
46
|
|
705
|
+
47
|
|
706
|
+
48
|
|
707
|
+
49
|
|
708
|
+
50</pre>
|
|
690
709
|
</td>
|
|
691
710
|
<td>
|
|
692
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
711
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 39</span>
|
|
693
712
|
|
|
694
|
-
<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='rparen'>)</span>
|
|
713
|
+
<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'>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>
|
|
695
714
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span>
|
|
696
715
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
697
716
|
<span class='rbrace'>}</span>
|
|
@@ -699,6 +718,7 @@
|
|
|
699
718
|
<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>
|
|
700
719
|
<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>
|
|
701
720
|
<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>
|
|
721
|
+
<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>
|
|
702
722
|
<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>
|
|
703
723
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
704
724
|
<span class='kw'>end</span></pre>
|
|
@@ -710,7 +730,7 @@
|
|
|
710
730
|
<div class="method_details ">
|
|
711
731
|
<h3 class="signature " id="create!-instance_method">
|
|
712
732
|
|
|
713
|
-
#<strong>create!</strong>(description: "", metadata: "", acl: []) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
733
|
+
#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
714
734
|
|
|
715
735
|
|
|
716
736
|
|
|
@@ -779,7 +799,25 @@
|
|
|
779
799
|
|
|
780
800
|
—
|
|
781
801
|
<div class='inline'>
|
|
782
|
-
<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
|
|
802
|
+
<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>
|
|
803
|
+
</div>
|
|
804
|
+
|
|
805
|
+
</li>
|
|
806
|
+
|
|
807
|
+
<li>
|
|
808
|
+
|
|
809
|
+
<span class='name'>owner_id</span>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
—
|
|
819
|
+
<div class='inline'>
|
|
820
|
+
<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>
|
|
783
821
|
</div>
|
|
784
822
|
|
|
785
823
|
</li>
|
|
@@ -811,22 +849,23 @@
|
|
|
811
849
|
<pre class="lines">
|
|
812
850
|
|
|
813
851
|
|
|
814
|
-
61
|
|
815
|
-
62
|
|
816
|
-
63
|
|
817
|
-
64
|
|
818
|
-
65
|
|
819
852
|
66
|
|
820
853
|
67
|
|
821
854
|
68
|
|
822
855
|
69
|
|
823
856
|
70
|
|
824
|
-
71
|
|
857
|
+
71
|
|
858
|
+
72
|
|
859
|
+
73
|
|
860
|
+
74
|
|
861
|
+
75
|
|
862
|
+
76
|
|
863
|
+
77</pre>
|
|
825
864
|
</td>
|
|
826
865
|
<td>
|
|
827
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
866
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 66</span>
|
|
828
867
|
|
|
829
|
-
<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='rparen'>)</span>
|
|
868
|
+
<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'>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>
|
|
830
869
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span>
|
|
831
870
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
832
871
|
<span class='rbrace'>}</span>
|
|
@@ -834,6 +873,7 @@
|
|
|
834
873
|
<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>
|
|
835
874
|
<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>
|
|
836
875
|
<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>
|
|
876
|
+
<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>
|
|
837
877
|
<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>
|
|
838
878
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Credential.html#initialize-instance_method" title="NgrokAPI::Models::Credential#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
839
879
|
<span class='kw'>end</span></pre>
|
|
@@ -910,16 +950,16 @@
|
|
|
910
950
|
<pre class="lines">
|
|
911
951
|
|
|
912
952
|
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
953
|
+
86
|
|
954
|
+
87
|
|
955
|
+
88
|
|
956
|
+
89
|
|
957
|
+
90
|
|
958
|
+
91
|
|
959
|
+
92</pre>
|
|
920
960
|
</td>
|
|
921
961
|
<td>
|
|
922
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
962
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 86</span>
|
|
923
963
|
|
|
924
964
|
<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>
|
|
925
965
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1001,16 +1041,16 @@
|
|
|
1001
1041
|
<pre class="lines">
|
|
1002
1042
|
|
|
1003
1043
|
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1044
|
+
102
|
|
1045
|
+
103
|
|
1046
|
+
104
|
|
1047
|
+
105
|
|
1048
|
+
106
|
|
1049
|
+
107
|
|
1050
|
+
108</pre>
|
|
1011
1051
|
</td>
|
|
1012
1052
|
<td>
|
|
1013
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1053
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 102</span>
|
|
1014
1054
|
|
|
1015
1055
|
<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>
|
|
1016
1056
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1092,18 +1132,18 @@
|
|
|
1092
1132
|
<pre class="lines">
|
|
1093
1133
|
|
|
1094
1134
|
|
|
1095
|
-
111
|
|
1096
|
-
112
|
|
1097
|
-
113
|
|
1098
|
-
114
|
|
1099
|
-
115
|
|
1100
|
-
116
|
|
1101
1135
|
117
|
|
1102
1136
|
118
|
|
1103
|
-
119
|
|
1137
|
+
119
|
|
1138
|
+
120
|
|
1139
|
+
121
|
|
1140
|
+
122
|
|
1141
|
+
123
|
|
1142
|
+
124
|
|
1143
|
+
125</pre>
|
|
1104
1144
|
</td>
|
|
1105
1145
|
<td>
|
|
1106
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1146
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 117</span>
|
|
1107
1147
|
|
|
1108
1148
|
<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>
|
|
1109
1149
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1187,18 +1227,18 @@
|
|
|
1187
1227
|
<pre class="lines">
|
|
1188
1228
|
|
|
1189
1229
|
|
|
1190
|
-
129
|
|
1191
|
-
130
|
|
1192
|
-
131
|
|
1193
|
-
132
|
|
1194
|
-
133
|
|
1195
|
-
134
|
|
1196
1230
|
135
|
|
1197
1231
|
136
|
|
1198
|
-
137
|
|
1232
|
+
137
|
|
1233
|
+
138
|
|
1234
|
+
139
|
|
1235
|
+
140
|
|
1236
|
+
141
|
|
1237
|
+
142
|
|
1238
|
+
143</pre>
|
|
1199
1239
|
</td>
|
|
1200
1240
|
<td>
|
|
1201
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1241
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 135</span>
|
|
1202
1242
|
|
|
1203
1243
|
<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>
|
|
1204
1244
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1308,12 +1348,6 @@
|
|
|
1308
1348
|
<pre class="lines">
|
|
1309
1349
|
|
|
1310
1350
|
|
|
1311
|
-
148
|
|
1312
|
-
149
|
|
1313
|
-
150
|
|
1314
|
-
151
|
|
1315
|
-
152
|
|
1316
|
-
153
|
|
1317
1351
|
154
|
|
1318
1352
|
155
|
|
1319
1353
|
156
|
|
@@ -1322,10 +1356,16 @@
|
|
|
1322
1356
|
159
|
|
1323
1357
|
160
|
|
1324
1358
|
161
|
|
1325
|
-
162
|
|
1359
|
+
162
|
|
1360
|
+
163
|
|
1361
|
+
164
|
|
1362
|
+
165
|
|
1363
|
+
166
|
|
1364
|
+
167
|
|
1365
|
+
168</pre>
|
|
1326
1366
|
</td>
|
|
1327
1367
|
<td>
|
|
1328
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1368
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 154</span>
|
|
1329
1369
|
|
|
1330
1370
|
<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>
|
|
1331
1371
|
<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>
|
|
@@ -1441,12 +1481,6 @@
|
|
|
1441
1481
|
<pre class="lines">
|
|
1442
1482
|
|
|
1443
1483
|
|
|
1444
|
-
174
|
|
1445
|
-
175
|
|
1446
|
-
176
|
|
1447
|
-
177
|
|
1448
|
-
178
|
|
1449
|
-
179
|
|
1450
1484
|
180
|
|
1451
1485
|
181
|
|
1452
1486
|
182
|
|
@@ -1457,10 +1491,16 @@
|
|
|
1457
1491
|
187
|
|
1458
1492
|
188
|
|
1459
1493
|
189
|
|
1460
|
-
190
|
|
1494
|
+
190
|
|
1495
|
+
191
|
|
1496
|
+
192
|
|
1497
|
+
193
|
|
1498
|
+
194
|
|
1499
|
+
195
|
|
1500
|
+
196</pre>
|
|
1461
1501
|
</td>
|
|
1462
1502
|
<td>
|
|
1463
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1503
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 180</span>
|
|
1464
1504
|
|
|
1465
1505
|
<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>
|
|
1466
1506
|
<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>
|
|
@@ -1569,7 +1609,7 @@
|
|
|
1569
1609
|
|
|
1570
1610
|
—
|
|
1571
1611
|
<div class='inline'>
|
|
1572
|
-
<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
|
|
1612
|
+
<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>
|
|
1573
1613
|
</div>
|
|
1574
1614
|
|
|
1575
1615
|
</li>
|
|
@@ -1601,21 +1641,21 @@
|
|
|
1601
1641
|
<pre class="lines">
|
|
1602
1642
|
|
|
1603
1643
|
|
|
1604
|
-
202
|
|
1605
|
-
203
|
|
1606
|
-
204
|
|
1607
|
-
205
|
|
1608
|
-
206
|
|
1609
|
-
207
|
|
1610
1644
|
208
|
|
1611
1645
|
209
|
|
1612
1646
|
210
|
|
1613
1647
|
211
|
|
1614
1648
|
212
|
|
1615
|
-
213
|
|
1649
|
+
213
|
|
1650
|
+
214
|
|
1651
|
+
215
|
|
1652
|
+
216
|
|
1653
|
+
217
|
|
1654
|
+
218
|
|
1655
|
+
219</pre>
|
|
1616
1656
|
</td>
|
|
1617
1657
|
<td>
|
|
1618
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1658
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 208</span>
|
|
1619
1659
|
|
|
1620
1660
|
<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>
|
|
1621
1661
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1719,7 +1759,7 @@
|
|
|
1719
1759
|
|
|
1720
1760
|
—
|
|
1721
1761
|
<div class='inline'>
|
|
1722
|
-
<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
|
|
1762
|
+
<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>
|
|
1723
1763
|
</div>
|
|
1724
1764
|
|
|
1725
1765
|
</li>
|
|
@@ -1751,21 +1791,21 @@
|
|
|
1751
1791
|
<pre class="lines">
|
|
1752
1792
|
|
|
1753
1793
|
|
|
1754
|
-
226
|
|
1755
|
-
227
|
|
1756
|
-
228
|
|
1757
|
-
229
|
|
1758
|
-
230
|
|
1759
|
-
231
|
|
1760
1794
|
232
|
|
1761
1795
|
233
|
|
1762
1796
|
234
|
|
1763
1797
|
235
|
|
1764
1798
|
236
|
|
1765
|
-
237
|
|
1799
|
+
237
|
|
1800
|
+
238
|
|
1801
|
+
239
|
|
1802
|
+
240
|
|
1803
|
+
241
|
|
1804
|
+
242
|
|
1805
|
+
243</pre>
|
|
1766
1806
|
</td>
|
|
1767
1807
|
<td>
|
|
1768
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1808
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 232</span>
|
|
1769
1809
|
|
|
1770
1810
|
<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>
|
|
1771
1811
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1789,9 +1829,9 @@
|
|
|
1789
1829
|
</div>
|
|
1790
1830
|
|
|
1791
1831
|
<div id="footer">
|
|
1792
|
-
Generated on
|
|
1793
|
-
<a href="
|
|
1794
|
-
0.9.
|
|
1832
|
+
Generated on Thu Aug 24 20:57:31 2023 by
|
|
1833
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1834
|
+
0.9.34 (ruby-3.0.6).
|
|
1795
1835
|
</div>
|
|
1796
1836
|
|
|
1797
1837
|
</div>
|