konnect.GatewayPluginHeaderCertAuth

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args GatewayPluginHeaderCertAuthArgs

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 GatewayPluginHeaderCertAuthArgs

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 GatewayPluginHeaderCertAuthArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginHeaderCertAuthArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginHeaderCertAuthArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config GatewayPluginHeaderCertAuthConfig

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Enabled bool

Whether the plugin is applied.

GatewayPluginHeaderCertAuthId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginHeaderCertAuthOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Route GatewayPluginHeaderCertAuthRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

Service GatewayPluginHeaderCertAuthService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags List<string>

An optional set of strings associated with the Plugin for grouping and filtering.

Config GatewayPluginHeaderCertAuthConfigArgs

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Enabled bool

Whether the plugin is applied.

GatewayPluginHeaderCertAuthId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginHeaderCertAuthOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Route GatewayPluginHeaderCertAuthRouteArgs

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

Service GatewayPluginHeaderCertAuthServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

Tags []string

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHeaderCertAuthConfig

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled Boolean

Whether the plugin is applied.

gatewayPluginHeaderCertAuthId String

The ID of this resource.

instanceName String

ordering GatewayPluginHeaderCertAuthOrdering

protocols List<String>

A set of strings representing HTTP protocols.

route GatewayPluginHeaderCertAuthRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginHeaderCertAuthService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHeaderCertAuthConfig

controlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled boolean

Whether the plugin is applied.

gatewayPluginHeaderCertAuthId string

The ID of this resource.

instanceName string

ordering GatewayPluginHeaderCertAuthOrdering

protocols string[]

A set of strings representing HTTP protocols.

route GatewayPluginHeaderCertAuthRoute

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginHeaderCertAuthService

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags string[]

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHeaderCertAuthConfigArgs

control_plane_id str

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled bool

Whether the plugin is applied.

gateway_plugin_header_cert_auth_id str

The ID of this resource.

instance_name str

ordering GatewayPluginHeaderCertAuthOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

route GatewayPluginHeaderCertAuthRouteArgs

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service GatewayPluginHeaderCertAuthServiceArgs

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags Sequence[str]

An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

enabled Boolean

Whether the plugin is applied.

gatewayPluginHeaderCertAuthId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A set of strings representing HTTP protocols.

route Property Map

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

service Property Map

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

CreatedAt double

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt double

Unix epoch when the resource was last updated.

CreatedAt float64

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt float64

Unix epoch when the resource was last updated.

createdAt Double

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Double

Unix epoch when the resource was last updated.

createdAt number

Unix epoch when the resource was created.

id string

The provider-assigned unique ID for this managed resource.

updatedAt number

Unix epoch when the resource was last updated.

created_at float

Unix epoch when the resource was created.

id str

The provider-assigned unique ID for this managed resource.

updated_at float

Unix epoch when the resource was last updated.

createdAt Number

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Number

Unix epoch when the resource was last updated.

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.

AllowPartialChain bool

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

Anonymous string

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

AuthenticatedGroupBy string

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

CaCertificates List<string>

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

CacheTtl double

Cache expiry time in seconds.

CertCacheTtl double

The length of time in milliseconds between refreshes of the revocation check status cache.

CertificateHeaderFormat string

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

CertificateHeaderName string

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

ConsumerBies List<string>

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

DefaultConsumer string

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

HttpProxyHost string

A string representing a host name, such as example.com.

HttpProxyPort double

An integer representing a port number between 0 and 65535, inclusive.

HttpTimeout double

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

HttpsProxyHost string

A string representing a host name, such as example.com.

HttpsProxyPort double

An integer representing a port number between 0 and 65535, inclusive.

RevocationCheckMode string

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

SecureSource bool

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

SkipConsumerLookup bool

Skip consumer lookup once certificate is trusted against the configured CA list.

AllowPartialChain bool

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

Anonymous string

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

AuthenticatedGroupBy string

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

CaCertificates []string

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

CacheTtl float64

Cache expiry time in seconds.

CertCacheTtl float64

The length of time in milliseconds between refreshes of the revocation check status cache.

CertificateHeaderFormat string

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

CertificateHeaderName string

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

ConsumerBies []string

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

DefaultConsumer string

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

HttpProxyHost string

A string representing a host name, such as example.com.

HttpProxyPort float64

An integer representing a port number between 0 and 65535, inclusive.

HttpTimeout float64

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

HttpsProxyHost string

A string representing a host name, such as example.com.

HttpsProxyPort float64

An integer representing a port number between 0 and 65535, inclusive.

RevocationCheckMode string

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

SecureSource bool

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

SkipConsumerLookup bool

Skip consumer lookup once certificate is trusted against the configured CA list.

allowPartialChain Boolean

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

anonymous String

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

authenticatedGroupBy String

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

caCertificates List<String>

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

cacheTtl Double

Cache expiry time in seconds.

certCacheTtl Double

The length of time in milliseconds between refreshes of the revocation check status cache.

certificateHeaderFormat String

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

certificateHeaderName String

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

consumerBies List<String>

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

defaultConsumer String

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

httpProxyHost String

A string representing a host name, such as example.com.

httpProxyPort Double

An integer representing a port number between 0 and 65535, inclusive.

httpTimeout Double

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

httpsProxyHost String

A string representing a host name, such as example.com.

httpsProxyPort Double

An integer representing a port number between 0 and 65535, inclusive.

revocationCheckMode String

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

secureSource Boolean

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

skipConsumerLookup Boolean

Skip consumer lookup once certificate is trusted against the configured CA list.

allowPartialChain boolean

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

anonymous string

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

authenticatedGroupBy string

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

caCertificates string[]

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

cacheTtl number

Cache expiry time in seconds.

certCacheTtl number

The length of time in milliseconds between refreshes of the revocation check status cache.

certificateHeaderFormat string

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

certificateHeaderName string

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

consumerBies string[]

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

defaultConsumer string

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

httpProxyHost string

A string representing a host name, such as example.com.

httpProxyPort number

An integer representing a port number between 0 and 65535, inclusive.

httpTimeout number

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

httpsProxyHost string

A string representing a host name, such as example.com.

httpsProxyPort number

An integer representing a port number between 0 and 65535, inclusive.

revocationCheckMode string

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

secureSource boolean

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

skipConsumerLookup boolean

Skip consumer lookup once certificate is trusted against the configured CA list.

allow_partial_chain bool

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

anonymous str

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

authenticated_group_by str

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

ca_certificates Sequence[str]

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

cache_ttl float

Cache expiry time in seconds.

cert_cache_ttl float

The length of time in milliseconds between refreshes of the revocation check status cache.

certificate_header_format str

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

certificate_header_name str

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

consumer_bies Sequence[str]

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

default_consumer str

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

http_proxy_host str

A string representing a host name, such as example.com.

http_proxy_port float

An integer representing a port number between 0 and 65535, inclusive.

http_timeout float

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

https_proxy_host str

A string representing a host name, such as example.com.

https_proxy_port float

An integer representing a port number between 0 and 65535, inclusive.

revocation_check_mode str

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

secure_source bool

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

skip_consumer_lookup bool

Skip consumer lookup once certificate is trusted against the configured CA list.

allowPartialChain Boolean

Allow certificate verification with only an intermediate certificate. When this is enabled, you don't need to upload the full chain to Kong Certificates.

anonymous String

An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

authenticatedGroupBy String

Certificate property to use as the authenticated group. Valid values are CN (Common Name) or DN (Distinguished Name). Once skip_consumer_lookup is applied, any client with a valid certificate can access the Service/API. To restrict usage to only some of the authenticated users, also add the ACL plugin (not covered here) and create allowed or denied groups of users. must be one of ["CN", "DN"]

caCertificates List<String>

List of CA Certificates strings to use as Certificate Authorities (CA) when validating a client certificate. At least one is required but you can specify as many as needed. The value of this array is comprised of primary keys (id).

cacheTtl Number

Cache expiry time in seconds.

certCacheTtl Number

The length of time in milliseconds between refreshes of the revocation check status cache.

certificateHeaderFormat String

Format of the certificate header. Supported formats: base64_encoded, url_encoded. must be one of ["base64encoded", "urlencoded"]

certificateHeaderName String

Name of the header that contains the certificate, received from the WAF or other L7 downstream proxy.

consumerBies List<String>

Whether to match the subject name of the client-supplied certificate against consumer's username and/or custom_id attribute. If set to [] (the empty array), then auto-matching is disabled.

defaultConsumer String

The UUID or username of the consumer to use when a trusted client certificate is presented but no consumer matches. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

httpProxyHost String

A string representing a host name, such as example.com.

httpProxyPort Number

An integer representing a port number between 0 and 65535, inclusive.

httpTimeout Number

HTTP timeout threshold in milliseconds when communicating with the OCSP server or downloading CRL.

httpsProxyHost String

A string representing a host name, such as example.com.

httpsProxyPort Number

An integer representing a port number between 0 and 65535, inclusive.

revocationCheckMode String

Controls client certificate revocation check behavior. If set to SKIP, no revocation check is performed. If set to IGNORE_CA_ERROR, the plugin respects the revocation status when either OCSP or CRL URL is set, and doesn't fail on network issues. If set to STRICT, the plugin only treats the certificate as valid when it's able to verify the revocation status. must be one of ["IGNORECAERROR", "SKIP", "STRICT"]

secureSource Boolean

Whether to secure the source of the request. If set to true, the plugin will only allow requests from trusted IPs (configured by the trusted_ips config option).

skipConsumerLookup Boolean

Skip consumer lookup once certificate is trusted against the configured CA list.

After GatewayPluginHeaderCertAuthOrderingAfter

Before GatewayPluginHeaderCertAuthOrderingBefore

After GatewayPluginHeaderCertAuthOrderingAfter

Before GatewayPluginHeaderCertAuthOrderingBefore

after GatewayPluginHeaderCertAuthOrderingAfter

before GatewayPluginHeaderCertAuthOrderingBefore

after GatewayPluginHeaderCertAuthOrderingAfter

before GatewayPluginHeaderCertAuthOrderingBefore

after GatewayPluginHeaderCertAuthOrderingAfter

before GatewayPluginHeaderCertAuthOrderingBefore

after Property Map

before Property Map

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Id string

Id string

id String

id string

id str

id String

Id string

Id string

id String

id string

id str

id String