konnect.GatewayPluginLdapAuthAdvanced

Coming soon!

Coming soon!

Coming soon!

resource_name This property is required. str

The unique name of the resource.

args This property is required. GatewayPluginLdapAuthAdvancedArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginLdapAuthAdvancedArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginLdapAuthAdvancedArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name This property is required. String

The unique name of the resource.

args This property is required. GatewayPluginLdapAuthAdvancedArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId This property is required. string

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

Config GatewayPluginLdapAuthAdvancedConfig

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginLdapAuthAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginLdapAuthAdvancedOrdering

Protocols List<string>

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Route GatewayPluginLdapAuthAdvancedRoute

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 GatewayPluginLdapAuthAdvancedService

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.

UpdatedAt double

Unix epoch when the resource was last updated.

ControlPlaneId This property is required. string

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

Config GatewayPluginLdapAuthAdvancedConfigArgs

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginLdapAuthAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginLdapAuthAdvancedOrderingArgs

Protocols []string

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Route GatewayPluginLdapAuthAdvancedRouteArgs

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 GatewayPluginLdapAuthAdvancedServiceArgs

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.

UpdatedAt float64

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

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

config GatewayPluginLdapAuthAdvancedConfig

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginLdapAuthAdvancedId String

The ID of this resource.

instanceName String

ordering GatewayPluginLdapAuthAdvancedOrdering

protocols List<String>

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

route GatewayPluginLdapAuthAdvancedRoute

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 GatewayPluginLdapAuthAdvancedService

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.

updatedAt Double

Unix epoch when the resource was last updated.

control_plane_id This property is required. str

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

config GatewayPluginLdapAuthAdvancedConfigArgs

created_at float

Unix epoch when the resource was created.

enabled bool

Whether the plugin is applied.

gateway_plugin_ldap_auth_advanced_id str

The ID of this resource.

instance_name str

ordering GatewayPluginLdapAuthAdvancedOrderingArgs

protocols Sequence[str]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

route GatewayPluginLdapAuthAdvancedRouteArgs

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 GatewayPluginLdapAuthAdvancedServiceArgs

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.

updated_at float

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

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

config Property Map

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginLdapAuthAdvancedId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

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.

updatedAt Number

Unix epoch when the resource was last updated.

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.

resource_name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

name This property is required.

The unique name of the resulting resource.

id This property is required.

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 This property is required.

The unique name of the resulting resource.

id This property is required.

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 This property is required.

The unique name of the resulting resource.

id This property is required.

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.

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 will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

Attribute string

Attribute to be used to search the user; e.g., "cn".

BaseDn string

Base DN as the starting point for the search; e.g., 'dc=example,dc=com'.

BindDn string

The DN to bind to. Used to perform LDAP search of user. This bind_dn should have permissions to search for the user being authenticated.

CacheTtl double

Cache expiry time in seconds.

ConsumerBies List<string>

Whether to authenticate consumers based on username, custom_id, or both.

ConsumerOptional bool

Whether consumer mapping is optional. If consumer_optional=true, the plugin will not attempt to associate a consumer with the LDAP authenticated user.

GroupBaseDn string

Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.',dc=com'.

GroupMemberAttribute string

Sets the attribute holding the members of the LDAP group. This field is case-sensitive.

GroupNameAttribute string

Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP). This field is case-insensitive.

GroupsRequireds List<string>

The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both AND / OR cases. - When ["group1 group2"] are in the same array indices, both group1 AND group2 need to be present in the LDAP search result. - When ["group1", "group2"] are in different array indices, either group1 OR group2 need to be present in the LDAP search result.

HeaderType string

An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: Authorization: ldap base64(username:password). If header_type is set to "basic", then the Authorization header would be Authorization: basic base64(username:password). Note that header_type can take any string, not just 'ldap' and 'basic'.

HideCredentials bool

An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

Keepalive double

An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

LdapHost string

Host on which the LDAP server is running.

LdapPassword string

The password to the LDAP server.

LdapPort double

TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636.

Ldaps bool

Set it to true to use ldaps, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

LogSearchResults bool

Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment.

Realm string

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

StartTls bool

Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

Timeout double

An optional timeout in milliseconds when waiting for connection with LDAP server.

VerifyLdapHost bool

Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

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 will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

Attribute string

Attribute to be used to search the user; e.g., "cn".

BaseDn string

Base DN as the starting point for the search; e.g., 'dc=example,dc=com'.

BindDn string

The DN to bind to. Used to perform LDAP search of user. This bind_dn should have permissions to search for the user being authenticated.

CacheTtl float64

Cache expiry time in seconds.

ConsumerBies []string

Whether to authenticate consumers based on username, custom_id, or both.

ConsumerOptional bool

Whether consumer mapping is optional. If consumer_optional=true, the plugin will not attempt to associate a consumer with the LDAP authenticated user.

GroupBaseDn string

Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.',dc=com'.

GroupMemberAttribute string

Sets the attribute holding the members of the LDAP group. This field is case-sensitive.

GroupNameAttribute string

Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP). This field is case-insensitive.

GroupsRequireds []string

The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both AND / OR cases. - When ["group1 group2"] are in the same array indices, both group1 AND group2 need to be present in the LDAP search result. - When ["group1", "group2"] are in different array indices, either group1 OR group2 need to be present in the LDAP search result.

HeaderType string

An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: Authorization: ldap base64(username:password). If header_type is set to "basic", then the Authorization header would be Authorization: basic base64(username:password). Note that header_type can take any string, not just 'ldap' and 'basic'.

HideCredentials bool

An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

Keepalive float64

An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

LdapHost string

Host on which the LDAP server is running.

LdapPassword string

The password to the LDAP server.

LdapPort float64

TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636.

Ldaps bool

Set it to true to use ldaps, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

LogSearchResults bool

Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment.

Realm string

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

StartTls bool

Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

Timeout float64

An optional timeout in milliseconds when waiting for connection with LDAP server.

VerifyLdapHost bool

Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

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 will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

attribute String

Attribute to be used to search the user; e.g., "cn".

baseDn String

Base DN as the starting point for the search; e.g., 'dc=example,dc=com'.

bindDn String

The DN to bind to. Used to perform LDAP search of user. This bind_dn should have permissions to search for the user being authenticated.

cacheTtl Double

Cache expiry time in seconds.

consumerBies List<String>

Whether to authenticate consumers based on username, custom_id, or both.

consumerOptional Boolean

Whether consumer mapping is optional. If consumer_optional=true, the plugin will not attempt to associate a consumer with the LDAP authenticated user.

groupBaseDn String

Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.',dc=com'.

groupMemberAttribute String

Sets the attribute holding the members of the LDAP group. This field is case-sensitive.

groupNameAttribute String

Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP). This field is case-insensitive.

groupsRequireds List<String>

The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both AND / OR cases. - When ["group1 group2"] are in the same array indices, both group1 AND group2 need to be present in the LDAP search result. - When ["group1", "group2"] are in different array indices, either group1 OR group2 need to be present in the LDAP search result.

headerType String

An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: Authorization: ldap base64(username:password). If header_type is set to "basic", then the Authorization header would be Authorization: basic base64(username:password). Note that header_type can take any string, not just 'ldap' and 'basic'.

hideCredentials Boolean

An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

keepalive Double

An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

ldapHost String

Host on which the LDAP server is running.

ldapPassword String

The password to the LDAP server.

ldapPort Double

TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636.

ldaps Boolean

Set it to true to use ldaps, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

logSearchResults Boolean

Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment.

realm String

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

startTls Boolean

Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

timeout Double

An optional timeout in milliseconds when waiting for connection with LDAP server.

verifyLdapHost Boolean

Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

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 will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

attribute str

Attribute to be used to search the user; e.g., "cn".

base_dn str

Base DN as the starting point for the search; e.g., 'dc=example,dc=com'.

bind_dn str

The DN to bind to. Used to perform LDAP search of user. This bind_dn should have permissions to search for the user being authenticated.

cache_ttl float

Cache expiry time in seconds.

consumer_bies Sequence[str]

Whether to authenticate consumers based on username, custom_id, or both.

consumer_optional bool

Whether consumer mapping is optional. If consumer_optional=true, the plugin will not attempt to associate a consumer with the LDAP authenticated user.

group_base_dn str

Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.',dc=com'.

group_member_attribute str

Sets the attribute holding the members of the LDAP group. This field is case-sensitive.

group_name_attribute str

Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP). This field is case-insensitive.

groups_requireds Sequence[str]

The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both AND / OR cases. - When ["group1 group2"] are in the same array indices, both group1 AND group2 need to be present in the LDAP search result. - When ["group1", "group2"] are in different array indices, either group1 OR group2 need to be present in the LDAP search result.

header_type str

An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: Authorization: ldap base64(username:password). If header_type is set to "basic", then the Authorization header would be Authorization: basic base64(username:password). Note that header_type can take any string, not just 'ldap' and 'basic'.

hide_credentials bool

An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

keepalive float

An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

ldap_host str

Host on which the LDAP server is running.

ldap_password str

The password to the LDAP server.

ldap_port float

TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636.

ldaps bool

Set it to true to use ldaps, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

log_search_results bool

Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment.

realm str

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

start_tls bool

Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

timeout float

An optional timeout in milliseconds when waiting for connection with LDAP server.

verify_ldap_host bool

Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

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 will fail with an authentication failure 4xx. Note that this value must refer to the consumer id or username attribute, and not its custom_id.

attribute String

Attribute to be used to search the user; e.g., "cn".

baseDn String

Base DN as the starting point for the search; e.g., 'dc=example,dc=com'.

bindDn String

The DN to bind to. Used to perform LDAP search of user. This bind_dn should have permissions to search for the user being authenticated.

cacheTtl Number

Cache expiry time in seconds.

consumerBies List<String>

Whether to authenticate consumers based on username, custom_id, or both.

consumerOptional Boolean

Whether consumer mapping is optional. If consumer_optional=true, the plugin will not attempt to associate a consumer with the LDAP authenticated user.

groupBaseDn String

Sets a distinguished name (DN) for the entry where LDAP searches for groups begin. This field is case-insensitive.',dc=com'.

groupMemberAttribute String

Sets the attribute holding the members of the LDAP group. This field is case-sensitive.

groupNameAttribute String

Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP). This field is case-insensitive.

groupsRequireds List<String>

The groups required to be present in the LDAP search result for successful authorization. This config parameter works in both AND / OR cases. - When ["group1 group2"] are in the same array indices, both group1 AND group2 need to be present in the LDAP search result. - When ["group1", "group2"] are in different array indices, either group1 OR group2 need to be present in the LDAP search result.

headerType String

An optional string to use as part of the Authorization header. By default, a valid Authorization header looks like this: Authorization: ldap base64(username:password). If header_type is set to "basic", then the Authorization header would be Authorization: basic base64(username:password). Note that header_type can take any string, not just 'ldap' and 'basic'.

hideCredentials Boolean

An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

keepalive Number

An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

ldapHost String

Host on which the LDAP server is running.

ldapPassword String

The password to the LDAP server.

ldapPort Number

TCP port where the LDAP server is listening. 389 is the default port for non-SSL LDAP and AD. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636.

ldaps Boolean

Set it to true to use ldaps, a secure protocol (that can be configured to TLS) to connect to the LDAP server. When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

logSearchResults Boolean

Displays all the LDAP search results received from the LDAP server for debugging purposes. Not recommended to be enabled in a production environment.

realm String

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

startTls Boolean

Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

timeout Number

An optional timeout in milliseconds when waiting for connection with LDAP server.

verifyLdapHost Boolean

Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

After GatewayPluginLdapAuthAdvancedOrderingAfter

Before GatewayPluginLdapAuthAdvancedOrderingBefore

After GatewayPluginLdapAuthAdvancedOrderingAfter

Before GatewayPluginLdapAuthAdvancedOrderingBefore

after GatewayPluginLdapAuthAdvancedOrderingAfter

before GatewayPluginLdapAuthAdvancedOrderingBefore

after GatewayPluginLdapAuthAdvancedOrderingAfter

before GatewayPluginLdapAuthAdvancedOrderingBefore

after Property Map

before Property Map

Accesses List<string>

Accesses []string

accesses List<String>

accesses Sequence[str]

accesses List<String>

Accesses List<string>

Accesses []string

accesses List<String>

accesses Sequence[str]

accesses List<String>

Id string

Id string

id String

id str

id String

Id string

Id string

id String

id str

id String