ngrok.EndpointConfiguration
Explore with Pulumi AI
Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ngrok = PiersKarsenbarg.Ngrok;
return await Deployment.RunAsync(() =>
{
var example = new Ngrok.EndpointConfiguration("example", new()
{
Description = "app servers",
RequestHeaders = new[]
{
new Ngrok.Inputs.EndpointConfigurationRequestHeaderArgs
{
Add =
{
{ "x-frontend", "ngrok" },
},
Removes = new[]
{
"cache-control",
},
},
},
Type = "https",
});
});
package main
import (
"github.com/pulumi/pulumi-ngrok/sdk/go/ngrok"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ngrok.NewEndpointConfiguration(ctx, "example", &ngrok.EndpointConfigurationArgs{
Description: pulumi.String("app servers"),
RequestHeaders: ngrok.EndpointConfigurationRequestHeaderArray{
&ngrok.EndpointConfigurationRequestHeaderArgs{
Add: pulumi.StringMap{
"x-frontend": pulumi.String("ngrok"),
},
Removes: pulumi.StringArray{
pulumi.String("cache-control"),
},
},
},
Type: pulumi.String("https"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ngrok.EndpointConfiguration;
import com.pulumi.ngrok.EndpointConfigurationArgs;
import com.pulumi.ngrok.inputs.EndpointConfigurationRequestHeaderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new EndpointConfiguration("example", EndpointConfigurationArgs.builder()
.description("app servers")
.requestHeaders(EndpointConfigurationRequestHeaderArgs.builder()
.add(Map.of("x-frontend", "ngrok"))
.removes("cache-control")
.build())
.type("https")
.build());
}
}
import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok
example = ngrok.EndpointConfiguration("example",
description="app servers",
request_headers=[ngrok.EndpointConfigurationRequestHeaderArgs(
add={
"x-frontend": "ngrok",
},
removes=["cache-control"],
)],
type="https")
import * as pulumi from "@pulumi/pulumi";
import * as ngrok from "@pierskarsenbarg/ngrok";
const example = new ngrok.EndpointConfiguration("example", {
description: "app servers",
requestHeaders: [{
add: {
"x-frontend": "ngrok",
},
removes: ["cache-control"],
}],
type: "https",
});
resources:
example:
type: ngrok:EndpointConfiguration
properties:
description: app servers
requestHeaders:
- add:
x-frontend: ngrok
removes:
- cache-control
type: https
Create EndpointConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EndpointConfiguration(name: string, args?: EndpointConfigurationArgs, opts?: CustomResourceOptions);
@overload
def EndpointConfiguration(resource_name: str,
args: Optional[EndpointConfigurationArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def EndpointConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
backends: Optional[Sequence[EndpointConfigurationBackendArgs]] = None,
basic_auths: Optional[Sequence[EndpointConfigurationBasicAuthArgs]] = None,
circuit_breakers: Optional[Sequence[EndpointConfigurationCircuitBreakerArgs]] = None,
compressions: Optional[Sequence[EndpointConfigurationCompressionArgs]] = None,
description: Optional[str] = None,
ip_policies: Optional[Sequence[EndpointConfigurationIpPolicyArgs]] = None,
loggings: Optional[Sequence[EndpointConfigurationLoggingArgs]] = None,
metadata: Optional[str] = None,
mutual_tls: Optional[Sequence[EndpointConfigurationMutualTlArgs]] = None,
oauths: Optional[Sequence[EndpointConfigurationOauthArgs]] = None,
oidcs: Optional[Sequence[EndpointConfigurationOidcArgs]] = None,
request_headers: Optional[Sequence[EndpointConfigurationRequestHeaderArgs]] = None,
response_headers: Optional[Sequence[EndpointConfigurationResponseHeaderArgs]] = None,
samls: Optional[Sequence[EndpointConfigurationSamlArgs]] = None,
tls_terminations: Optional[Sequence[EndpointConfigurationTlsTerminationArgs]] = None,
type: Optional[str] = None,
webhook_validations: Optional[Sequence[EndpointConfigurationWebhookValidationArgs]] = None)
func NewEndpointConfiguration(ctx *Context, name string, args *EndpointConfigurationArgs, opts ...ResourceOption) (*EndpointConfiguration, error)
public EndpointConfiguration(string name, EndpointConfigurationArgs? args = null, CustomResourceOptions? opts = null)
public EndpointConfiguration(String name, EndpointConfigurationArgs args)
public EndpointConfiguration(String name, EndpointConfigurationArgs args, CustomResourceOptions options)
type: ngrok:EndpointConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args EndpointConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EndpointConfigurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EndpointConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EndpointConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EndpointConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var endpointConfigurationResource = new Ngrok.EndpointConfiguration("endpointConfigurationResource", new()
{
Backends = new[]
{
new Ngrok.Inputs.EndpointConfigurationBackendArgs
{
Backends = new[]
{
new Ngrok.Inputs.EndpointConfigurationBackendBackendArgs
{
Id = "string",
Uri = "string",
},
},
Enabled = false,
},
},
BasicAuths = new[]
{
new Ngrok.Inputs.EndpointConfigurationBasicAuthArgs
{
AllowOptions = false,
AuthProviderId = "string",
Enabled = false,
Realm = "string",
},
},
CircuitBreakers = new[]
{
new Ngrok.Inputs.EndpointConfigurationCircuitBreakerArgs
{
Enabled = false,
ErrorThresholdPercentage = 0,
NumBuckets = 0,
RollingWindow = 0,
TrippedDuration = 0,
VolumeThreshold = 0,
},
},
Compressions = new[]
{
new Ngrok.Inputs.EndpointConfigurationCompressionArgs
{
Enabled = false,
},
},
Description = "string",
IpPolicies = new[]
{
new Ngrok.Inputs.EndpointConfigurationIpPolicyArgs
{
Enabled = false,
IpPolicies = new[]
{
new Ngrok.Inputs.EndpointConfigurationIpPolicyIpPolicyArgs
{
Id = "string",
Uri = "string",
},
},
},
},
Loggings = new[]
{
new Ngrok.Inputs.EndpointConfigurationLoggingArgs
{
Enabled = false,
EventStreams = new[]
{
new Ngrok.Inputs.EndpointConfigurationLoggingEventStreamArgs
{
Id = "string",
Uri = "string",
},
},
},
},
Metadata = "string",
MutualTls = new[]
{
new Ngrok.Inputs.EndpointConfigurationMutualTlArgs
{
CertificateAuthorities = new[]
{
new Ngrok.Inputs.EndpointConfigurationMutualTlCertificateAuthorityArgs
{
Id = "string",
Uri = "string",
},
},
Enabled = false,
},
},
Oauths = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthArgs
{
AuthCheckInterval = 0,
CookiePrefix = "string",
Enabled = false,
InactivityTimeout = 0,
MaximumDuration = 0,
OptionsPassthrough = false,
Providers = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthProviderArgs
{
Facebooks = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthProviderFacebookArgs
{
ClientId = "string",
ClientSecret = "string",
EmailAddresses = new[]
{
"string",
},
EmailDomains = new[]
{
"string",
},
Scopes = new[]
{
"string",
},
},
},
Githubs = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthProviderGithubArgs
{
ClientId = "string",
ClientSecret = "string",
EmailAddresses = new[]
{
"string",
},
EmailDomains = new[]
{
"string",
},
Organizations = new[]
{
"string",
},
Scopes = new[]
{
"string",
},
Teams = new[]
{
"string",
},
},
},
Googles = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthProviderGoogleArgs
{
ClientId = "string",
ClientSecret = "string",
EmailAddresses = new[]
{
"string",
},
EmailDomains = new[]
{
"string",
},
Scopes = new[]
{
"string",
},
},
},
Microsofts = new[]
{
new Ngrok.Inputs.EndpointConfigurationOauthProviderMicrosoftArgs
{
ClientId = "string",
ClientSecret = "string",
EmailAddresses = new[]
{
"string",
},
EmailDomains = new[]
{
"string",
},
Scopes = new[]
{
"string",
},
},
},
},
},
},
},
Oidcs = new[]
{
new Ngrok.Inputs.EndpointConfigurationOidcArgs
{
ClientId = "string",
ClientSecret = "string",
CookiePrefix = "string",
Enabled = false,
InactivityTimeout = 0,
Issuer = "string",
MaximumDuration = 0,
OptionsPassthrough = false,
Scopes = new[]
{
"string",
},
},
},
RequestHeaders = new[]
{
new Ngrok.Inputs.EndpointConfigurationRequestHeaderArgs
{
Add =
{
{ "string", "string" },
},
Enabled = false,
Removes = new[]
{
"string",
},
},
},
ResponseHeaders = new[]
{
new Ngrok.Inputs.EndpointConfigurationResponseHeaderArgs
{
Add =
{
{ "string", "string" },
},
Enabled = false,
Removes = new[]
{
"string",
},
},
},
Samls = new[]
{
new Ngrok.Inputs.EndpointConfigurationSamlArgs
{
AllowIdpInitiated = false,
AssertionConsumerServiceUrl = "string",
AuthorizedGroups = new[]
{
"string",
},
CookiePrefix = "string",
Enabled = false,
EntityId = "string",
ForceAuthn = false,
IdpMetadata = "string",
IdpMetadataUrl = "string",
InactivityTimeout = 0,
MaximumDuration = 0,
MetadataUrl = "string",
NameidFormat = "string",
OptionsPassthrough = false,
RequestSigningCertificatePem = "string",
SingleLogoutUrl = "string",
},
},
TlsTerminations = new[]
{
new Ngrok.Inputs.EndpointConfigurationTlsTerminationArgs
{
Enabled = false,
MinVersion = "string",
TerminateAt = "string",
},
},
Type = "string",
WebhookValidations = new[]
{
new Ngrok.Inputs.EndpointConfigurationWebhookValidationArgs
{
Enabled = false,
Provider = "string",
Secret = "string",
},
},
});
example, err := ngrok.NewEndpointConfiguration(ctx, "endpointConfigurationResource", &ngrok.EndpointConfigurationArgs{
Backends: ngrok.EndpointConfigurationBackendArray{
&ngrok.EndpointConfigurationBackendArgs{
Backends: ngrok.EndpointConfigurationBackendBackendArray{
&ngrok.EndpointConfigurationBackendBackendArgs{
Id: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
},
},
BasicAuths: ngrok.EndpointConfigurationBasicAuthArray{
&ngrok.EndpointConfigurationBasicAuthArgs{
AllowOptions: pulumi.Bool(false),
AuthProviderId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Realm: pulumi.String("string"),
},
},
CircuitBreakers: ngrok.EndpointConfigurationCircuitBreakerArray{
&ngrok.EndpointConfigurationCircuitBreakerArgs{
Enabled: pulumi.Bool(false),
ErrorThresholdPercentage: pulumi.Float64(0),
NumBuckets: pulumi.Int(0),
RollingWindow: pulumi.Int(0),
TrippedDuration: pulumi.Int(0),
VolumeThreshold: pulumi.Int(0),
},
},
Compressions: ngrok.EndpointConfigurationCompressionArray{
&ngrok.EndpointConfigurationCompressionArgs{
Enabled: pulumi.Bool(false),
},
},
Description: pulumi.String("string"),
IpPolicies: ngrok.EndpointConfigurationIpPolicyArray{
&ngrok.EndpointConfigurationIpPolicyArgs{
Enabled: pulumi.Bool(false),
IpPolicies: ngrok.EndpointConfigurationIpPolicyIpPolicyArray{
&ngrok.EndpointConfigurationIpPolicyIpPolicyArgs{
Id: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
},
},
Loggings: ngrok.EndpointConfigurationLoggingArray{
&ngrok.EndpointConfigurationLoggingArgs{
Enabled: pulumi.Bool(false),
EventStreams: ngrok.EndpointConfigurationLoggingEventStreamArray{
&ngrok.EndpointConfigurationLoggingEventStreamArgs{
Id: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
},
},
Metadata: pulumi.String("string"),
MutualTls: ngrok.EndpointConfigurationMutualTlArray{
&ngrok.EndpointConfigurationMutualTlArgs{
CertificateAuthorities: ngrok.EndpointConfigurationMutualTlCertificateAuthorityArray{
&ngrok.EndpointConfigurationMutualTlCertificateAuthorityArgs{
Id: pulumi.String("string"),
Uri: pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
},
},
Oauths: ngrok.EndpointConfigurationOauthArray{
&ngrok.EndpointConfigurationOauthArgs{
AuthCheckInterval: pulumi.Int(0),
CookiePrefix: pulumi.String("string"),
Enabled: pulumi.Bool(false),
InactivityTimeout: pulumi.Int(0),
MaximumDuration: pulumi.Int(0),
OptionsPassthrough: pulumi.Bool(false),
Providers: ngrok.EndpointConfigurationOauthProviderArray{
&ngrok.EndpointConfigurationOauthProviderArgs{
Facebooks: ngrok.EndpointConfigurationOauthProviderFacebookArray{
&ngrok.EndpointConfigurationOauthProviderFacebookArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
EmailDomains: pulumi.StringArray{
pulumi.String("string"),
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Githubs: ngrok.EndpointConfigurationOauthProviderGithubArray{
&ngrok.EndpointConfigurationOauthProviderGithubArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
EmailDomains: pulumi.StringArray{
pulumi.String("string"),
},
Organizations: pulumi.StringArray{
pulumi.String("string"),
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
Teams: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Googles: ngrok.EndpointConfigurationOauthProviderGoogleArray{
&ngrok.EndpointConfigurationOauthProviderGoogleArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
EmailDomains: pulumi.StringArray{
pulumi.String("string"),
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Microsofts: ngrok.EndpointConfigurationOauthProviderMicrosoftArray{
&ngrok.EndpointConfigurationOauthProviderMicrosoftArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
EmailAddresses: pulumi.StringArray{
pulumi.String("string"),
},
EmailDomains: pulumi.StringArray{
pulumi.String("string"),
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
},
},
},
Oidcs: ngrok.EndpointConfigurationOidcArray{
&ngrok.EndpointConfigurationOidcArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
CookiePrefix: pulumi.String("string"),
Enabled: pulumi.Bool(false),
InactivityTimeout: pulumi.Int(0),
Issuer: pulumi.String("string"),
MaximumDuration: pulumi.Int(0),
OptionsPassthrough: pulumi.Bool(false),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
RequestHeaders: ngrok.EndpointConfigurationRequestHeaderArray{
&ngrok.EndpointConfigurationRequestHeaderArgs{
Add: pulumi.StringMap{
"string": pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
Removes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ResponseHeaders: ngrok.EndpointConfigurationResponseHeaderArray{
&ngrok.EndpointConfigurationResponseHeaderArgs{
Add: pulumi.StringMap{
"string": pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
Removes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Samls: ngrok.EndpointConfigurationSamlArray{
&ngrok.EndpointConfigurationSamlArgs{
AllowIdpInitiated: pulumi.Bool(false),
AssertionConsumerServiceUrl: pulumi.String("string"),
AuthorizedGroups: pulumi.StringArray{
pulumi.String("string"),
},
CookiePrefix: pulumi.String("string"),
Enabled: pulumi.Bool(false),
EntityId: pulumi.String("string"),
ForceAuthn: pulumi.Bool(false),
IdpMetadata: pulumi.String("string"),
IdpMetadataUrl: pulumi.String("string"),
InactivityTimeout: pulumi.Int(0),
MaximumDuration: pulumi.Int(0),
MetadataUrl: pulumi.String("string"),
NameidFormat: pulumi.String("string"),
OptionsPassthrough: pulumi.Bool(false),
RequestSigningCertificatePem: pulumi.String("string"),
SingleLogoutUrl: pulumi.String("string"),
},
},
TlsTerminations: ngrok.EndpointConfigurationTlsTerminationArray{
&ngrok.EndpointConfigurationTlsTerminationArgs{
Enabled: pulumi.Bool(false),
MinVersion: pulumi.String("string"),
TerminateAt: pulumi.String("string"),
},
},
Type: pulumi.String("string"),
WebhookValidations: ngrok.EndpointConfigurationWebhookValidationArray{
&ngrok.EndpointConfigurationWebhookValidationArgs{
Enabled: pulumi.Bool(false),
Provider: pulumi.String("string"),
Secret: pulumi.String("string"),
},
},
})
var endpointConfigurationResource = new EndpointConfiguration("endpointConfigurationResource", EndpointConfigurationArgs.builder()
.backends(EndpointConfigurationBackendArgs.builder()
.backends(EndpointConfigurationBackendBackendArgs.builder()
.id("string")
.uri("string")
.build())
.enabled(false)
.build())
.basicAuths(EndpointConfigurationBasicAuthArgs.builder()
.allowOptions(false)
.authProviderId("string")
.enabled(false)
.realm("string")
.build())
.circuitBreakers(EndpointConfigurationCircuitBreakerArgs.builder()
.enabled(false)
.errorThresholdPercentage(0)
.numBuckets(0)
.rollingWindow(0)
.trippedDuration(0)
.volumeThreshold(0)
.build())
.compressions(EndpointConfigurationCompressionArgs.builder()
.enabled(false)
.build())
.description("string")
.ipPolicies(EndpointConfigurationIpPolicyArgs.builder()
.enabled(false)
.ipPolicies(EndpointConfigurationIpPolicyIpPolicyArgs.builder()
.id("string")
.uri("string")
.build())
.build())
.loggings(EndpointConfigurationLoggingArgs.builder()
.enabled(false)
.eventStreams(EndpointConfigurationLoggingEventStreamArgs.builder()
.id("string")
.uri("string")
.build())
.build())
.metadata("string")
.mutualTls(EndpointConfigurationMutualTlArgs.builder()
.certificateAuthorities(EndpointConfigurationMutualTlCertificateAuthorityArgs.builder()
.id("string")
.uri("string")
.build())
.enabled(false)
.build())
.oauths(EndpointConfigurationOauthArgs.builder()
.authCheckInterval(0)
.cookiePrefix("string")
.enabled(false)
.inactivityTimeout(0)
.maximumDuration(0)
.optionsPassthrough(false)
.providers(EndpointConfigurationOauthProviderArgs.builder()
.facebooks(EndpointConfigurationOauthProviderFacebookArgs.builder()
.clientId("string")
.clientSecret("string")
.emailAddresses("string")
.emailDomains("string")
.scopes("string")
.build())
.githubs(EndpointConfigurationOauthProviderGithubArgs.builder()
.clientId("string")
.clientSecret("string")
.emailAddresses("string")
.emailDomains("string")
.organizations("string")
.scopes("string")
.teams("string")
.build())
.googles(EndpointConfigurationOauthProviderGoogleArgs.builder()
.clientId("string")
.clientSecret("string")
.emailAddresses("string")
.emailDomains("string")
.scopes("string")
.build())
.microsofts(EndpointConfigurationOauthProviderMicrosoftArgs.builder()
.clientId("string")
.clientSecret("string")
.emailAddresses("string")
.emailDomains("string")
.scopes("string")
.build())
.build())
.build())
.oidcs(EndpointConfigurationOidcArgs.builder()
.clientId("string")
.clientSecret("string")
.cookiePrefix("string")
.enabled(false)
.inactivityTimeout(0)
.issuer("string")
.maximumDuration(0)
.optionsPassthrough(false)
.scopes("string")
.build())
.requestHeaders(EndpointConfigurationRequestHeaderArgs.builder()
.add(Map.of("string", "string"))
.enabled(false)
.removes("string")
.build())
.responseHeaders(EndpointConfigurationResponseHeaderArgs.builder()
.add(Map.of("string", "string"))
.enabled(false)
.removes("string")
.build())
.samls(EndpointConfigurationSamlArgs.builder()
.allowIdpInitiated(false)
.assertionConsumerServiceUrl("string")
.authorizedGroups("string")
.cookiePrefix("string")
.enabled(false)
.entityId("string")
.forceAuthn(false)
.idpMetadata("string")
.idpMetadataUrl("string")
.inactivityTimeout(0)
.maximumDuration(0)
.metadataUrl("string")
.nameidFormat("string")
.optionsPassthrough(false)
.requestSigningCertificatePem("string")
.singleLogoutUrl("string")
.build())
.tlsTerminations(EndpointConfigurationTlsTerminationArgs.builder()
.enabled(false)
.minVersion("string")
.terminateAt("string")
.build())
.type("string")
.webhookValidations(EndpointConfigurationWebhookValidationArgs.builder()
.enabled(false)
.provider("string")
.secret("string")
.build())
.build());
endpoint_configuration_resource = ngrok.EndpointConfiguration("endpointConfigurationResource",
backends=[ngrok.EndpointConfigurationBackendArgs(
backends=[ngrok.EndpointConfigurationBackendBackendArgs(
id="string",
uri="string",
)],
enabled=False,
)],
basic_auths=[ngrok.EndpointConfigurationBasicAuthArgs(
allow_options=False,
auth_provider_id="string",
enabled=False,
realm="string",
)],
circuit_breakers=[ngrok.EndpointConfigurationCircuitBreakerArgs(
enabled=False,
error_threshold_percentage=0,
num_buckets=0,
rolling_window=0,
tripped_duration=0,
volume_threshold=0,
)],
compressions=[ngrok.EndpointConfigurationCompressionArgs(
enabled=False,
)],
description="string",
ip_policies=[ngrok.EndpointConfigurationIpPolicyArgs(
enabled=False,
ip_policies=[ngrok.EndpointConfigurationIpPolicyIpPolicyArgs(
id="string",
uri="string",
)],
)],
loggings=[ngrok.EndpointConfigurationLoggingArgs(
enabled=False,
event_streams=[ngrok.EndpointConfigurationLoggingEventStreamArgs(
id="string",
uri="string",
)],
)],
metadata="string",
mutual_tls=[ngrok.EndpointConfigurationMutualTlArgs(
certificate_authorities=[ngrok.EndpointConfigurationMutualTlCertificateAuthorityArgs(
id="string",
uri="string",
)],
enabled=False,
)],
oauths=[ngrok.EndpointConfigurationOauthArgs(
auth_check_interval=0,
cookie_prefix="string",
enabled=False,
inactivity_timeout=0,
maximum_duration=0,
options_passthrough=False,
providers=[ngrok.EndpointConfigurationOauthProviderArgs(
facebooks=[ngrok.EndpointConfigurationOauthProviderFacebookArgs(
client_id="string",
client_secret="string",
email_addresses=["string"],
email_domains=["string"],
scopes=["string"],
)],
githubs=[ngrok.EndpointConfigurationOauthProviderGithubArgs(
client_id="string",
client_secret="string",
email_addresses=["string"],
email_domains=["string"],
organizations=["string"],
scopes=["string"],
teams=["string"],
)],
googles=[ngrok.EndpointConfigurationOauthProviderGoogleArgs(
client_id="string",
client_secret="string",
email_addresses=["string"],
email_domains=["string"],
scopes=["string"],
)],
microsofts=[ngrok.EndpointConfigurationOauthProviderMicrosoftArgs(
client_id="string",
client_secret="string",
email_addresses=["string"],
email_domains=["string"],
scopes=["string"],
)],
)],
)],
oidcs=[ngrok.EndpointConfigurationOidcArgs(
client_id="string",
client_secret="string",
cookie_prefix="string",
enabled=False,
inactivity_timeout=0,
issuer="string",
maximum_duration=0,
options_passthrough=False,
scopes=["string"],
)],
request_headers=[ngrok.EndpointConfigurationRequestHeaderArgs(
add={
"string": "string",
},
enabled=False,
removes=["string"],
)],
response_headers=[ngrok.EndpointConfigurationResponseHeaderArgs(
add={
"string": "string",
},
enabled=False,
removes=["string"],
)],
samls=[ngrok.EndpointConfigurationSamlArgs(
allow_idp_initiated=False,
assertion_consumer_service_url="string",
authorized_groups=["string"],
cookie_prefix="string",
enabled=False,
entity_id="string",
force_authn=False,
idp_metadata="string",
idp_metadata_url="string",
inactivity_timeout=0,
maximum_duration=0,
metadata_url="string",
nameid_format="string",
options_passthrough=False,
request_signing_certificate_pem="string",
single_logout_url="string",
)],
tls_terminations=[ngrok.EndpointConfigurationTlsTerminationArgs(
enabled=False,
min_version="string",
terminate_at="string",
)],
type="string",
webhook_validations=[ngrok.EndpointConfigurationWebhookValidationArgs(
enabled=False,
provider="string",
secret="string",
)])
const endpointConfigurationResource = new ngrok.EndpointConfiguration("endpointConfigurationResource", {
backends: [{
backends: [{
id: "string",
uri: "string",
}],
enabled: false,
}],
basicAuths: [{
allowOptions: false,
authProviderId: "string",
enabled: false,
realm: "string",
}],
circuitBreakers: [{
enabled: false,
errorThresholdPercentage: 0,
numBuckets: 0,
rollingWindow: 0,
trippedDuration: 0,
volumeThreshold: 0,
}],
compressions: [{
enabled: false,
}],
description: "string",
ipPolicies: [{
enabled: false,
ipPolicies: [{
id: "string",
uri: "string",
}],
}],
loggings: [{
enabled: false,
eventStreams: [{
id: "string",
uri: "string",
}],
}],
metadata: "string",
mutualTls: [{
certificateAuthorities: [{
id: "string",
uri: "string",
}],
enabled: false,
}],
oauths: [{
authCheckInterval: 0,
cookiePrefix: "string",
enabled: false,
inactivityTimeout: 0,
maximumDuration: 0,
optionsPassthrough: false,
providers: [{
facebooks: [{
clientId: "string",
clientSecret: "string",
emailAddresses: ["string"],
emailDomains: ["string"],
scopes: ["string"],
}],
githubs: [{
clientId: "string",
clientSecret: "string",
emailAddresses: ["string"],
emailDomains: ["string"],
organizations: ["string"],
scopes: ["string"],
teams: ["string"],
}],
googles: [{
clientId: "string",
clientSecret: "string",
emailAddresses: ["string"],
emailDomains: ["string"],
scopes: ["string"],
}],
microsofts: [{
clientId: "string",
clientSecret: "string",
emailAddresses: ["string"],
emailDomains: ["string"],
scopes: ["string"],
}],
}],
}],
oidcs: [{
clientId: "string",
clientSecret: "string",
cookiePrefix: "string",
enabled: false,
inactivityTimeout: 0,
issuer: "string",
maximumDuration: 0,
optionsPassthrough: false,
scopes: ["string"],
}],
requestHeaders: [{
add: {
string: "string",
},
enabled: false,
removes: ["string"],
}],
responseHeaders: [{
add: {
string: "string",
},
enabled: false,
removes: ["string"],
}],
samls: [{
allowIdpInitiated: false,
assertionConsumerServiceUrl: "string",
authorizedGroups: ["string"],
cookiePrefix: "string",
enabled: false,
entityId: "string",
forceAuthn: false,
idpMetadata: "string",
idpMetadataUrl: "string",
inactivityTimeout: 0,
maximumDuration: 0,
metadataUrl: "string",
nameidFormat: "string",
optionsPassthrough: false,
requestSigningCertificatePem: "string",
singleLogoutUrl: "string",
}],
tlsTerminations: [{
enabled: false,
minVersion: "string",
terminateAt: "string",
}],
type: "string",
webhookValidations: [{
enabled: false,
provider: "string",
secret: "string",
}],
});
type: ngrok:EndpointConfiguration
properties:
backends:
- backends:
- id: string
uri: string
enabled: false
basicAuths:
- allowOptions: false
authProviderId: string
enabled: false
realm: string
circuitBreakers:
- enabled: false
errorThresholdPercentage: 0
numBuckets: 0
rollingWindow: 0
trippedDuration: 0
volumeThreshold: 0
compressions:
- enabled: false
description: string
ipPolicies:
- enabled: false
ipPolicies:
- id: string
uri: string
loggings:
- enabled: false
eventStreams:
- id: string
uri: string
metadata: string
mutualTls:
- certificateAuthorities:
- id: string
uri: string
enabled: false
oauths:
- authCheckInterval: 0
cookiePrefix: string
enabled: false
inactivityTimeout: 0
maximumDuration: 0
optionsPassthrough: false
providers:
- facebooks:
- clientId: string
clientSecret: string
emailAddresses:
- string
emailDomains:
- string
scopes:
- string
githubs:
- clientId: string
clientSecret: string
emailAddresses:
- string
emailDomains:
- string
organizations:
- string
scopes:
- string
teams:
- string
googles:
- clientId: string
clientSecret: string
emailAddresses:
- string
emailDomains:
- string
scopes:
- string
microsofts:
- clientId: string
clientSecret: string
emailAddresses:
- string
emailDomains:
- string
scopes:
- string
oidcs:
- clientId: string
clientSecret: string
cookiePrefix: string
enabled: false
inactivityTimeout: 0
issuer: string
maximumDuration: 0
optionsPassthrough: false
scopes:
- string
requestHeaders:
- add:
string: string
enabled: false
removes:
- string
responseHeaders:
- add:
string: string
enabled: false
removes:
- string
samls:
- allowIdpInitiated: false
assertionConsumerServiceUrl: string
authorizedGroups:
- string
cookiePrefix: string
enabled: false
entityId: string
forceAuthn: false
idpMetadata: string
idpMetadataUrl: string
inactivityTimeout: 0
maximumDuration: 0
metadataUrl: string
nameidFormat: string
optionsPassthrough: false
requestSigningCertificatePem: string
singleLogoutUrl: string
tlsTerminations:
- enabled: false
minVersion: string
terminateAt: string
type: string
webhookValidations:
- enabled: false
provider: string
secret: string
EndpointConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The EndpointConfiguration resource accepts the following input properties:
- Backends
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Backend> - backend module configuration or
null
- Basic
Auths List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Basic Auth> - basic auth module configuration or
null
- Circuit
Breakers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Circuit Breaker> - circuit breaker module configuration or
null
- Compressions
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Compression> - compression module configuration or
null
- Description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- Ip
Policies List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Ip Policy> - ip policy module configuration or
null
- Loggings
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Logging> - logging module configuration or
null
- Metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- Mutual
Tls List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Mutual Tl> - mutual TLS module configuration or
null
- Oauths
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth> - oauth module configuration or
null
- Oidcs
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oidc> - oidc module configuration or
null
- Request
Headers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Request Header> - request headers module configuration or
null
- Response
Headers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Response Header> - response headers module configuration or
null
- Samls
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Saml> - saml module configuration or
null
- Tls
Terminations List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Tls Termination> - TLS termination module configuration or
null
- Type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- Webhook
Validations List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Webhook Validation> - webhook validation module configuration or
null
- Backends
[]Endpoint
Configuration Backend Args - backend module configuration or
null
- Basic
Auths []EndpointConfiguration Basic Auth Args - basic auth module configuration or
null
- Circuit
Breakers []EndpointConfiguration Circuit Breaker Args - circuit breaker module configuration or
null
- Compressions
[]Endpoint
Configuration Compression Args - compression module configuration or
null
- Description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- Ip
Policies []EndpointConfiguration Ip Policy Args - ip policy module configuration or
null
- Loggings
[]Endpoint
Configuration Logging Args - logging module configuration or
null
- Metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- Mutual
Tls []EndpointConfiguration Mutual Tl Args - mutual TLS module configuration or
null
- Oauths
[]Endpoint
Configuration Oauth Args - oauth module configuration or
null
- Oidcs
[]Endpoint
Configuration Oidc Args - oidc module configuration or
null
- Request
Headers []EndpointConfiguration Request Header Args - request headers module configuration or
null
- Response
Headers []EndpointConfiguration Response Header Args - response headers module configuration or
null
- Samls
[]Endpoint
Configuration Saml Args - saml module configuration or
null
- Tls
Terminations []EndpointConfiguration Tls Termination Args - TLS termination module configuration or
null
- Type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- Webhook
Validations []EndpointConfiguration Webhook Validation Args - webhook validation module configuration or
null
- backends
List<Endpoint
Configuration Backend> - backend module configuration or
null
- basic
Auths List<EndpointConfiguration Basic Auth> - basic auth module configuration or
null
- circuit
Breakers List<EndpointConfiguration Circuit Breaker> - circuit breaker module configuration or
null
- compressions
List<Endpoint
Configuration Compression> - compression module configuration or
null
- description String
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies List<EndpointConfiguration Ip Policy> - ip policy module configuration or
null
- loggings
List<Endpoint
Configuration Logging> - logging module configuration or
null
- metadata String
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls List<EndpointConfiguration Mutual Tl> - mutual TLS module configuration or
null
- oauths
List<Endpoint
Configuration Oauth> - oauth module configuration or
null
- oidcs
List<Endpoint
Configuration Oidc> - oidc module configuration or
null
- request
Headers List<EndpointConfiguration Request Header> - request headers module configuration or
null
- response
Headers List<EndpointConfiguration Response Header> - response headers module configuration or
null
- samls
List<Endpoint
Configuration Saml> - saml module configuration or
null
- tls
Terminations List<EndpointConfiguration Tls Termination> - TLS termination module configuration or
null
- type String
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations List<EndpointConfiguration Webhook Validation> - webhook validation module configuration or
null
- backends
Endpoint
Configuration Backend[] - backend module configuration or
null
- basic
Auths EndpointConfiguration Basic Auth[] - basic auth module configuration or
null
- circuit
Breakers EndpointConfiguration Circuit Breaker[] - circuit breaker module configuration or
null
- compressions
Endpoint
Configuration Compression[] - compression module configuration or
null
- description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies EndpointConfiguration Ip Policy[] - ip policy module configuration or
null
- loggings
Endpoint
Configuration Logging[] - logging module configuration or
null
- metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls EndpointConfiguration Mutual Tl[] - mutual TLS module configuration or
null
- oauths
Endpoint
Configuration Oauth[] - oauth module configuration or
null
- oidcs
Endpoint
Configuration Oidc[] - oidc module configuration or
null
- request
Headers EndpointConfiguration Request Header[] - request headers module configuration or
null
- response
Headers EndpointConfiguration Response Header[] - response headers module configuration or
null
- samls
Endpoint
Configuration Saml[] - saml module configuration or
null
- tls
Terminations EndpointConfiguration Tls Termination[] - TLS termination module configuration or
null
- type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations EndpointConfiguration Webhook Validation[] - webhook validation module configuration or
null
- backends
Sequence[Endpoint
Configuration Backend Args] - backend module configuration or
null
- basic_
auths Sequence[EndpointConfiguration Basic Auth Args] - basic auth module configuration or
null
- circuit_
breakers Sequence[EndpointConfiguration Circuit Breaker Args] - circuit breaker module configuration or
null
- compressions
Sequence[Endpoint
Configuration Compression Args] - compression module configuration or
null
- description str
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip_
policies Sequence[EndpointConfiguration Ip Policy Args] - ip policy module configuration or
null
- loggings
Sequence[Endpoint
Configuration Logging Args] - logging module configuration or
null
- metadata str
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual_
tls Sequence[EndpointConfiguration Mutual Tl Args] - mutual TLS module configuration or
null
- oauths
Sequence[Endpoint
Configuration Oauth Args] - oauth module configuration or
null
- oidcs
Sequence[Endpoint
Configuration Oidc Args] - oidc module configuration or
null
- request_
headers Sequence[EndpointConfiguration Request Header Args] - request headers module configuration or
null
- response_
headers Sequence[EndpointConfiguration Response Header Args] - response headers module configuration or
null
- samls
Sequence[Endpoint
Configuration Saml Args] - saml module configuration or
null
- tls_
terminations Sequence[EndpointConfiguration Tls Termination Args] - TLS termination module configuration or
null
- type str
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook_
validations Sequence[EndpointConfiguration Webhook Validation Args] - webhook validation module configuration or
null
- backends List<Property Map>
- backend module configuration or
null
- basic
Auths List<Property Map> - basic auth module configuration or
null
- circuit
Breakers List<Property Map> - circuit breaker module configuration or
null
- compressions List<Property Map>
- compression module configuration or
null
- description String
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies List<Property Map> - ip policy module configuration or
null
- loggings List<Property Map>
- logging module configuration or
null
- metadata String
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls List<Property Map> - mutual TLS module configuration or
null
- oauths List<Property Map>
- oauth module configuration or
null
- oidcs List<Property Map>
- oidc module configuration or
null
- request
Headers List<Property Map> - request headers module configuration or
null
- response
Headers List<Property Map> - response headers module configuration or
null
- samls List<Property Map>
- saml module configuration or
null
- tls
Terminations List<Property Map> - TLS termination module configuration or
null
- type String
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations List<Property Map> - webhook validation module configuration or
null
Outputs
All input properties are implicitly available as output properties. Additionally, the EndpointConfiguration resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing EndpointConfiguration Resource
Get an existing EndpointConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EndpointConfigurationState, opts?: CustomResourceOptions): EndpointConfiguration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
backends: Optional[Sequence[EndpointConfigurationBackendArgs]] = None,
basic_auths: Optional[Sequence[EndpointConfigurationBasicAuthArgs]] = None,
circuit_breakers: Optional[Sequence[EndpointConfigurationCircuitBreakerArgs]] = None,
compressions: Optional[Sequence[EndpointConfigurationCompressionArgs]] = None,
description: Optional[str] = None,
ip_policies: Optional[Sequence[EndpointConfigurationIpPolicyArgs]] = None,
loggings: Optional[Sequence[EndpointConfigurationLoggingArgs]] = None,
metadata: Optional[str] = None,
mutual_tls: Optional[Sequence[EndpointConfigurationMutualTlArgs]] = None,
oauths: Optional[Sequence[EndpointConfigurationOauthArgs]] = None,
oidcs: Optional[Sequence[EndpointConfigurationOidcArgs]] = None,
request_headers: Optional[Sequence[EndpointConfigurationRequestHeaderArgs]] = None,
response_headers: Optional[Sequence[EndpointConfigurationResponseHeaderArgs]] = None,
samls: Optional[Sequence[EndpointConfigurationSamlArgs]] = None,
tls_terminations: Optional[Sequence[EndpointConfigurationTlsTerminationArgs]] = None,
type: Optional[str] = None,
webhook_validations: Optional[Sequence[EndpointConfigurationWebhookValidationArgs]] = None) -> EndpointConfiguration
func GetEndpointConfiguration(ctx *Context, name string, id IDInput, state *EndpointConfigurationState, opts ...ResourceOption) (*EndpointConfiguration, error)
public static EndpointConfiguration Get(string name, Input<string> id, EndpointConfigurationState? state, CustomResourceOptions? opts = null)
public static EndpointConfiguration get(String name, Output<String> id, EndpointConfigurationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Backends
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Backend> - backend module configuration or
null
- Basic
Auths List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Basic Auth> - basic auth module configuration or
null
- Circuit
Breakers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Circuit Breaker> - circuit breaker module configuration or
null
- Compressions
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Compression> - compression module configuration or
null
- Description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- Ip
Policies List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Ip Policy> - ip policy module configuration or
null
- Loggings
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Logging> - logging module configuration or
null
- Metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- Mutual
Tls List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Mutual Tl> - mutual TLS module configuration or
null
- Oauths
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth> - oauth module configuration or
null
- Oidcs
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oidc> - oidc module configuration or
null
- Request
Headers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Request Header> - request headers module configuration or
null
- Response
Headers List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Response Header> - response headers module configuration or
null
- Samls
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Saml> - saml module configuration or
null
- Tls
Terminations List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Tls Termination> - TLS termination module configuration or
null
- Type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- Webhook
Validations List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Webhook Validation> - webhook validation module configuration or
null
- Backends
[]Endpoint
Configuration Backend Args - backend module configuration or
null
- Basic
Auths []EndpointConfiguration Basic Auth Args - basic auth module configuration or
null
- Circuit
Breakers []EndpointConfiguration Circuit Breaker Args - circuit breaker module configuration or
null
- Compressions
[]Endpoint
Configuration Compression Args - compression module configuration or
null
- Description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- Ip
Policies []EndpointConfiguration Ip Policy Args - ip policy module configuration or
null
- Loggings
[]Endpoint
Configuration Logging Args - logging module configuration or
null
- Metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- Mutual
Tls []EndpointConfiguration Mutual Tl Args - mutual TLS module configuration or
null
- Oauths
[]Endpoint
Configuration Oauth Args - oauth module configuration or
null
- Oidcs
[]Endpoint
Configuration Oidc Args - oidc module configuration or
null
- Request
Headers []EndpointConfiguration Request Header Args - request headers module configuration or
null
- Response
Headers []EndpointConfiguration Response Header Args - response headers module configuration or
null
- Samls
[]Endpoint
Configuration Saml Args - saml module configuration or
null
- Tls
Terminations []EndpointConfiguration Tls Termination Args - TLS termination module configuration or
null
- Type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- Webhook
Validations []EndpointConfiguration Webhook Validation Args - webhook validation module configuration or
null
- backends
List<Endpoint
Configuration Backend> - backend module configuration or
null
- basic
Auths List<EndpointConfiguration Basic Auth> - basic auth module configuration or
null
- circuit
Breakers List<EndpointConfiguration Circuit Breaker> - circuit breaker module configuration or
null
- compressions
List<Endpoint
Configuration Compression> - compression module configuration or
null
- description String
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies List<EndpointConfiguration Ip Policy> - ip policy module configuration or
null
- loggings
List<Endpoint
Configuration Logging> - logging module configuration or
null
- metadata String
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls List<EndpointConfiguration Mutual Tl> - mutual TLS module configuration or
null
- oauths
List<Endpoint
Configuration Oauth> - oauth module configuration or
null
- oidcs
List<Endpoint
Configuration Oidc> - oidc module configuration or
null
- request
Headers List<EndpointConfiguration Request Header> - request headers module configuration or
null
- response
Headers List<EndpointConfiguration Response Header> - response headers module configuration or
null
- samls
List<Endpoint
Configuration Saml> - saml module configuration or
null
- tls
Terminations List<EndpointConfiguration Tls Termination> - TLS termination module configuration or
null
- type String
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations List<EndpointConfiguration Webhook Validation> - webhook validation module configuration or
null
- backends
Endpoint
Configuration Backend[] - backend module configuration or
null
- basic
Auths EndpointConfiguration Basic Auth[] - basic auth module configuration or
null
- circuit
Breakers EndpointConfiguration Circuit Breaker[] - circuit breaker module configuration or
null
- compressions
Endpoint
Configuration Compression[] - compression module configuration or
null
- description string
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies EndpointConfiguration Ip Policy[] - ip policy module configuration or
null
- loggings
Endpoint
Configuration Logging[] - logging module configuration or
null
- metadata string
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls EndpointConfiguration Mutual Tl[] - mutual TLS module configuration or
null
- oauths
Endpoint
Configuration Oauth[] - oauth module configuration or
null
- oidcs
Endpoint
Configuration Oidc[] - oidc module configuration or
null
- request
Headers EndpointConfiguration Request Header[] - request headers module configuration or
null
- response
Headers EndpointConfiguration Response Header[] - response headers module configuration or
null
- samls
Endpoint
Configuration Saml[] - saml module configuration or
null
- tls
Terminations EndpointConfiguration Tls Termination[] - TLS termination module configuration or
null
- type string
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations EndpointConfiguration Webhook Validation[] - webhook validation module configuration or
null
- backends
Sequence[Endpoint
Configuration Backend Args] - backend module configuration or
null
- basic_
auths Sequence[EndpointConfiguration Basic Auth Args] - basic auth module configuration or
null
- circuit_
breakers Sequence[EndpointConfiguration Circuit Breaker Args] - circuit breaker module configuration or
null
- compressions
Sequence[Endpoint
Configuration Compression Args] - compression module configuration or
null
- description str
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip_
policies Sequence[EndpointConfiguration Ip Policy Args] - ip policy module configuration or
null
- loggings
Sequence[Endpoint
Configuration Logging Args] - logging module configuration or
null
- metadata str
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual_
tls Sequence[EndpointConfiguration Mutual Tl Args] - mutual TLS module configuration or
null
- oauths
Sequence[Endpoint
Configuration Oauth Args] - oauth module configuration or
null
- oidcs
Sequence[Endpoint
Configuration Oidc Args] - oidc module configuration or
null
- request_
headers Sequence[EndpointConfiguration Request Header Args] - request headers module configuration or
null
- response_
headers Sequence[EndpointConfiguration Response Header Args] - response headers module configuration or
null
- samls
Sequence[Endpoint
Configuration Saml Args] - saml module configuration or
null
- tls_
terminations Sequence[EndpointConfiguration Tls Termination Args] - TLS termination module configuration or
null
- type str
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook_
validations Sequence[EndpointConfiguration Webhook Validation Args] - webhook validation module configuration or
null
- backends List<Property Map>
- backend module configuration or
null
- basic
Auths List<Property Map> - basic auth module configuration or
null
- circuit
Breakers List<Property Map> - circuit breaker module configuration or
null
- compressions List<Property Map>
- compression module configuration or
null
- description String
- human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
- ip
Policies List<Property Map> - ip policy module configuration or
null
- loggings List<Property Map>
- logging module configuration or
null
- metadata String
- arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
- mutual
Tls List<Property Map> - mutual TLS module configuration or
null
- oauths List<Property Map>
- oauth module configuration or
null
- oidcs List<Property Map>
- oidc module configuration or
null
- request
Headers List<Property Map> - request headers module configuration or
null
- response
Headers List<Property Map> - response headers module configuration or
null
- samls List<Property Map>
- saml module configuration or
null
- tls
Terminations List<Property Map> - TLS termination module configuration or
null
- type String
- they type of traffic this endpoint configuration can be applied to. one of:
http
,https
,tcp
- webhook
Validations List<Property Map> - webhook validation module configuration or
null
Supporting Types
EndpointConfigurationBackend, EndpointConfigurationBackendArgs
- Backends
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Backend Backend> - backend to be used to back this endpoint
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- Backends
[]Endpoint
Configuration Backend Backend - backend to be used to back this endpoint
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- backends
List<Endpoint
Configuration Backend Backend> - backend to be used to back this endpoint
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- backends
Endpoint
Configuration Backend Backend[] - backend to be used to back this endpoint
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- backends
Sequence[Endpoint
Configuration Backend Backend] - backend to be used to back this endpoint
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- backends List<Property Map>
- backend to be used to back this endpoint
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
EndpointConfigurationBackendBackend, EndpointConfigurationBackendBackendArgs
EndpointConfigurationBasicAuth, EndpointConfigurationBasicAuthArgs
- Allow
Options bool - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- Auth
Provider stringId - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Realm string
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
- Allow
Options bool - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- Auth
Provider stringId - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Realm string
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
- allow
Options Boolean - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- auth
Provider StringId - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- realm String
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
- allow
Options boolean - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- auth
Provider stringId - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- realm string
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
- allow_
options bool - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- auth_
provider_ strid - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- realm str
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
- allow
Options Boolean - true or false indicating whether to allow OPTIONS requests through without authentication which is necessary for CORS. default is
false
- auth
Provider StringId - determines how the basic auth credentials are validated. Currently only the value
agent
is supported which means that credentials will be validated against the username and password specified by the ngrok agent's--basic-auth
flag, if any. - enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- realm String
- an arbitrary string to be specified in as the 'realm' value in the
WWW-Authenticate
header. default isngrok
EndpointConfigurationCircuitBreaker, EndpointConfigurationCircuitBreakerArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Error
Threshold doublePercentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- Num
Buckets int - Integer number of buckets into which metrics are retained. Max 128.
- Rolling
Window int - Integer number of seconds in the statistical rolling window that metrics are retained for.
- Tripped
Duration int - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- Volume
Threshold int - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Error
Threshold float64Percentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- Num
Buckets int - Integer number of buckets into which metrics are retained. Max 128.
- Rolling
Window int - Integer number of seconds in the statistical rolling window that metrics are retained for.
- Tripped
Duration int - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- Volume
Threshold int - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- error
Threshold DoublePercentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- num
Buckets Integer - Integer number of buckets into which metrics are retained. Max 128.
- rolling
Window Integer - Integer number of seconds in the statistical rolling window that metrics are retained for.
- tripped
Duration Integer - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- volume
Threshold Integer - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- error
Threshold numberPercentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- num
Buckets number - Integer number of buckets into which metrics are retained. Max 128.
- rolling
Window number - Integer number of seconds in the statistical rolling window that metrics are retained for.
- tripped
Duration number - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- volume
Threshold number - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- error_
threshold_ floatpercentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- num_
buckets int - Integer number of buckets into which metrics are retained. Max 128.
- rolling_
window int - Integer number of seconds in the statistical rolling window that metrics are retained for.
- tripped_
duration int - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- volume_
threshold int - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- error
Threshold NumberPercentage - Error threshold percentage should be between 0 - 1.0, not 0-100.0
- num
Buckets Number - Integer number of buckets into which metrics are retained. Max 128.
- rolling
Window Number - Integer number of seconds in the statistical rolling window that metrics are retained for.
- tripped
Duration Number - Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
- volume
Threshold Number - Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
EndpointConfigurationCompression, EndpointConfigurationCompressionArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
EndpointConfigurationIpPolicy, EndpointConfigurationIpPolicyArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Ip
Policies List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Ip Policy Ip Policy>
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Ip
Policies []EndpointConfiguration Ip Policy Ip Policy
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- ip
Policies List<EndpointConfiguration Ip Policy Ip Policy>
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- ip
Policies EndpointConfiguration Ip Policy Ip Policy[]
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- ip_
policies Sequence[EndpointConfiguration Ip Policy Ip Policy]
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- ip
Policies List<Property Map>
EndpointConfigurationIpPolicyIpPolicy, EndpointConfigurationIpPolicyIpPolicyArgs
EndpointConfigurationLogging, EndpointConfigurationLoggingArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Event
Streams List<PiersKarsenbarg. Ngrok. Inputs. Endpoint Configuration Logging Event Stream> - list of all EventStreams that will be used to configure and export this endpoint's logs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Event
Streams []EndpointConfiguration Logging Event Stream - list of all EventStreams that will be used to configure and export this endpoint's logs
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- event
Streams List<EndpointConfiguration Logging Event Stream> - list of all EventStreams that will be used to configure and export this endpoint's logs
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- event
Streams EndpointConfiguration Logging Event Stream[] - list of all EventStreams that will be used to configure and export this endpoint's logs
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- event_
streams Sequence[EndpointConfiguration Logging Event Stream] - list of all EventStreams that will be used to configure and export this endpoint's logs
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- event
Streams List<Property Map> - list of all EventStreams that will be used to configure and export this endpoint's logs
EndpointConfigurationLoggingEventStream, EndpointConfigurationLoggingEventStreamArgs
EndpointConfigurationMutualTl, EndpointConfigurationMutualTlArgs
- List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Mutual Tl Certificate Authority> - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- []Endpoint
Configuration Mutual Tl Certificate Authority - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- List<Endpoint
Configuration Mutual Tl Certificate Authority> - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- Endpoint
Configuration Mutual Tl Certificate Authority[] - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- Sequence[Endpoint
Configuration Mutual Tl Certificate Authority] - PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
- List<Property Map>
- PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified
EndpointConfigurationMutualTlCertificateAuthority, EndpointConfigurationMutualTlCertificateAuthorityArgs
EndpointConfigurationOauth, EndpointConfigurationOauthArgs
- Auth
Check intInterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Providers
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth Provider> - an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- Auth
Check intInterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Providers
[]Endpoint
Configuration Oauth Provider - an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- auth
Check IntegerInterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout Integer - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration Integer - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- providers
List<Endpoint
Configuration Oauth Provider> - an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- auth
Check numberInterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- providers
Endpoint
Configuration Oauth Provider[] - an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- auth_
check_ intinterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- str
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity_
timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum_
duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options_
passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- providers
Sequence[Endpoint
Configuration Oauth Provider] - an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
- auth
Check NumberInterval - Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout Number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration Number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- providers List<Property Map>
- an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
EndpointConfigurationOauthProvider, EndpointConfigurationOauthProviderArgs
- Facebooks
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth Provider Facebook> - Githubs
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth Provider Github> - Googles
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth Provider Google> - Microsofts
List<Piers
Karsenbarg. Ngrok. Inputs. Endpoint Configuration Oauth Provider Microsoft>
EndpointConfigurationOauthProviderFacebook, EndpointConfigurationOauthProviderFacebookArgs
- Client
Id string - Client
Secret string - Email
Addresses List<string> - Email
Domains List<string> - Scopes List<string>
- Client
Id string - Client
Secret string - Email
Addresses []string - Email
Domains []string - Scopes []string
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
- client
Id string - client
Secret string - email
Addresses string[] - email
Domains string[] - scopes string[]
- client_
id str - client_
secret str - email_
addresses Sequence[str] - email_
domains Sequence[str] - scopes Sequence[str]
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
EndpointConfigurationOauthProviderGithub, EndpointConfigurationOauthProviderGithubArgs
- Client
Id string - Client
Secret string - Email
Addresses List<string> - Email
Domains List<string> - Organizations List<string>
- Scopes List<string>
- Teams List<string>
- Client
Id string - Client
Secret string - Email
Addresses []string - Email
Domains []string - Organizations []string
- Scopes []string
- Teams []string
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - organizations List<String>
- scopes List<String>
- teams List<String>
- client
Id string - client
Secret string - email
Addresses string[] - email
Domains string[] - organizations string[]
- scopes string[]
- teams string[]
- client_
id str - client_
secret str - email_
addresses Sequence[str] - email_
domains Sequence[str] - organizations Sequence[str]
- scopes Sequence[str]
- teams Sequence[str]
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - organizations List<String>
- scopes List<String>
- teams List<String>
EndpointConfigurationOauthProviderGoogle, EndpointConfigurationOauthProviderGoogleArgs
- Client
Id string - Client
Secret string - Email
Addresses List<string> - Email
Domains List<string> - Scopes List<string>
- Client
Id string - Client
Secret string - Email
Addresses []string - Email
Domains []string - Scopes []string
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
- client
Id string - client
Secret string - email
Addresses string[] - email
Domains string[] - scopes string[]
- client_
id str - client_
secret str - email_
addresses Sequence[str] - email_
domains Sequence[str] - scopes Sequence[str]
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
EndpointConfigurationOauthProviderMicrosoft, EndpointConfigurationOauthProviderMicrosoftArgs
- Client
Id string - Client
Secret string - Email
Addresses List<string> - Email
Domains List<string> - Scopes List<string>
- Client
Id string - Client
Secret string - Email
Addresses []string - Email
Domains []string - Scopes []string
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
- client
Id string - client
Secret string - email
Addresses string[] - email
Domains string[] - scopes string[]
- client_
id str - client_
secret str - email_
addresses Sequence[str] - email_
domains Sequence[str] - scopes Sequence[str]
- client
Id String - client
Secret String - email
Addresses List<String> - email
Domains List<String> - scopes List<String>
EndpointConfigurationOidc, EndpointConfigurationOidcArgs
- Client
Id string - The OIDC app's client ID and OIDC audience.
- Client
Secret string - The OIDC app's client secret.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Issuer string
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Scopes List<string>
- The set of scopes to request from the OIDC identity provider.
- Client
Id string - The OIDC app's client ID and OIDC audience.
- Client
Secret string - The OIDC app's client secret.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Issuer string
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Scopes []string
- The set of scopes to request from the OIDC identity provider.
- client
Id String - The OIDC app's client ID and OIDC audience.
- client
Secret String - The OIDC app's client secret.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout Integer - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- issuer String
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- maximum
Duration Integer - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- scopes List<String>
- The set of scopes to request from the OIDC identity provider.
- client
Id string - The OIDC app's client ID and OIDC audience.
- client
Secret string - The OIDC app's client secret.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- issuer string
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- maximum
Duration number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- scopes string[]
- The set of scopes to request from the OIDC identity provider.
- client_
id str - The OIDC app's client ID and OIDC audience.
- client_
secret str - The OIDC app's client secret.
- str
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity_
timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- issuer str
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- maximum_
duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options_
passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- scopes Sequence[str]
- The set of scopes to request from the OIDC identity provider.
- client
Id String - The OIDC app's client ID and OIDC audience.
- client
Secret String - The OIDC app's client secret.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- inactivity
Timeout Number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- issuer String
- URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- maximum
Duration Number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- scopes List<String>
- The set of scopes to request from the OIDC identity provider.
EndpointConfigurationRequestHeader, EndpointConfigurationRequestHeaderArgs
- Add Dictionary<string, string>
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Removes List<string>
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- Add map[string]string
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Removes []string
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- add Map<String,String>
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes List<String>
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- add {[key: string]: string}
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes string[]
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- add Mapping[str, str]
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes Sequence[str]
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
- add Map<String>
- a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes List<String>
- a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
EndpointConfigurationResponseHeader, EndpointConfigurationResponseHeaderArgs
- Add Dictionary<string, string>
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Removes List<string>
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
- Add map[string]string
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Removes []string
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
- add Map<String,String>
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes List<String>
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
- add {[key: string]: string}
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes string[]
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
- add Mapping[str, str]
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes Sequence[str]
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
- add Map<String>
- a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- removes List<String>
- a list of header names that will be removed from the HTTP Response returned to the HTTP client
EndpointConfigurationSaml, EndpointConfigurationSamlArgs
- Allow
Idp boolInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - Assertion
Consumer stringService Url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- List<string>
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Entity
Id string - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- Force
Authn bool - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- Idp
Metadata string - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- Idp
Metadata stringUrl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Metadata
Url string - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- Nameid
Format string - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Request
Signing stringCertificate Pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- Single
Logout stringUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
- Allow
Idp boolInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - Assertion
Consumer stringService Url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- []string
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Entity
Id string - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- Force
Authn bool - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- Idp
Metadata string - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- Idp
Metadata stringUrl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- Inactivity
Timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- Maximum
Duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- Metadata
Url string - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- Nameid
Format string - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - Options
Passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- Request
Signing stringCertificate Pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- Single
Logout stringUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
- allow
Idp BooleanInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - assertion
Consumer StringService Url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- List<String>
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- entity
Id String - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- force
Authn Boolean - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- idp
Metadata String - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- idp
Metadata StringUrl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- inactivity
Timeout Integer - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration Integer - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- metadata
Url String - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- nameid
Format String - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- request
Signing StringCertificate Pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- single
Logout StringUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
- allow
Idp booleanInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - assertion
Consumer stringService Url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- string[]
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- string
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- entity
Id string - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- force
Authn boolean - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- idp
Metadata string - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- idp
Metadata stringUrl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- inactivity
Timeout number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- metadata
Url string - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- nameid
Format string - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - options
Passthrough boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- request
Signing stringCertificate Pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- single
Logout stringUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
- allow_
idp_ boolinitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - assertion_
consumer_ strservice_ url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- Sequence[str]
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- str
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- entity_
id str - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- force_
authn bool - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- idp_
metadata str - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- idp_
metadata_ strurl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- inactivity_
timeout int - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum_
duration int - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- metadata_
url str - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- nameid_
format str - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - options_
passthrough bool - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- request_
signing_ strcertificate_ pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- single_
logout_ strurl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
- allow
Idp BooleanInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the
RelayState
parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed. - assertion
Consumer StringService Url - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
- List<String>
- If present, only users who are a member of one of the listed groups may access the target endpoint.
- String
- the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- entity
Id String - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
- force
Authn Boolean - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
- idp
Metadata String - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
- idp
Metadata StringUrl - The IdP's metadata URL which returns the XML IdP EntityDescriptor. The IdP's metadata URL specifies how to connect to the IdP as well as its public key which is then used to validate the signature on incoming SAML assertions to the ACS endpoint.
- inactivity
Timeout Number - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
- maximum
Duration Number - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- metadata
Url String - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
- nameid
Format String - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
will be used. A subset of the allowed values enumerated by the SAML specification are supported. - options
Passthrough Boolean - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- request
Signing StringCertificate Pem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
- single
Logout StringUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
EndpointConfigurationTlsTermination, EndpointConfigurationTlsTerminationArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Min
Version string - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - Terminate
At string edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Min
Version string - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - Terminate
At string edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- min
Version String - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - terminate
At String edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- min
Version string - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - terminate
At string edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- min_
version str - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - terminate_
at str edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- min
Version String - The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if
terminate_at
is set toupstream
. - terminate
At String edge
if the ngrok edge should terminate TLS traffic,upstream
if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. ifupstream
is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
EndpointConfigurationWebhookValidation, EndpointConfigurationWebhookValidationArgs
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Provider string
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - Secret string
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
- Enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- Provider string
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - Secret string
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- provider String
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - secret String
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
- enabled boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- provider string
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - secret string
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
- enabled bool
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- provider str
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - secret str
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
- enabled Boolean
true
if the module will be applied to traffic,false
to disable. defaulttrue
if unspecified- provider String
- a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers:
SLACK
,SNS
,STRIPE
,GITHUB
,TWILIO
,SHOPIFY
,GITLAB
,INTERCOM
,SENDGRID
,XERO
,PAGERDUTY
. - secret String
- a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
Package Details
- Repository
- ngrok pierskarsenbarg/pulumi-ngrok
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ngrok
Terraform Provider.