konnect 2.5.0, Apr 15 25

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginLdapAuth

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

Using getGatewayPluginLdapAuth

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginLdapAuth(args: GetGatewayPluginLdapAuthArgs, opts?: InvokeOptions): Promise<GetGatewayPluginLdapAuthResult>
function getGatewayPluginLdapAuthOutput(args: GetGatewayPluginLdapAuthOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginLdapAuthResult>

def get_gateway_plugin_ldap_auth(control_plane_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetGatewayPluginLdapAuthResult
def get_gateway_plugin_ldap_auth_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginLdapAuthResult]

func LookupGatewayPluginLdapAuth(ctx *Context, args *LookupGatewayPluginLdapAuthArgs, opts ...InvokeOption) (*LookupGatewayPluginLdapAuthResult, error)
func LookupGatewayPluginLdapAuthOutput(ctx *Context, args *LookupGatewayPluginLdapAuthOutputArgs, opts ...InvokeOption) LookupGatewayPluginLdapAuthResultOutput

> Note: This function is named LookupGatewayPluginLdapAuth in the Go SDK.

public static class GetGatewayPluginLdapAuth 
{
    public static Task<GetGatewayPluginLdapAuthResult> InvokeAsync(GetGatewayPluginLdapAuthArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginLdapAuthResult> Invoke(GetGatewayPluginLdapAuthInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginLdapAuthResult> getGatewayPluginLdapAuth(GetGatewayPluginLdapAuthArgs args, InvokeOptions options)
public static Output<GetGatewayPluginLdapAuthResult> getGatewayPluginLdapAuth(GetGatewayPluginLdapAuthArgs args, InvokeOptions options)

fn::invoke:
  function: konnect:index/getGatewayPluginLdapAuth:getGatewayPluginLdapAuth
  arguments:
    # arguments dictionary

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginLdapAuth Result

The following output properties are available:

Config GetGatewayPluginLdapAuthConfig
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginLdapAuthOrdering
Protocols List<string>
Route GetGatewayPluginLdapAuthRoute
Service GetGatewayPluginLdapAuthService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginLdapAuthConfig
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginLdapAuthOrdering
Protocols []string
Route GetGatewayPluginLdapAuthRoute
Service GetGatewayPluginLdapAuthService
Tags []string
UpdatedAt float64

config GetGatewayPluginLdapAuthConfig
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginLdapAuthOrdering
protocols List<String>
route GetGatewayPluginLdapAuthRoute
service GetGatewayPluginLdapAuthService
tags List<String>
updatedAt Double

config GetGatewayPluginLdapAuthConfig
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginLdapAuthOrdering
protocols string[]
route GetGatewayPluginLdapAuthRoute
service GetGatewayPluginLdapAuthService
tags string[]
updatedAt number

config GetGatewayPluginLdapAuthConfig
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginLdapAuthOrdering
protocols Sequence[str]
route GetGatewayPluginLdapAuthRoute
service GetGatewayPluginLdapAuthService
tags Sequence[str]
updated_at float

config Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginLdapAuthConfig

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.
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
CacheTtl double: Cache expiry time in seconds.
HeaderType string: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
LdapPort double: An integer representing a port number between 0 and 65535, inclusive.
Ldaps bool: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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 fails with an authentication failure 4xx.
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
CacheTtl float64: Cache expiry time in seconds.
HeaderType string: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
LdapPort float64: An integer representing a port number between 0 and 65535, inclusive.
Ldaps bool: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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 fails with an authentication failure 4xx.
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
cacheTtl Double: Cache expiry time in seconds.
headerType String: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
ldapPort Double: An integer representing a port number between 0 and 65535, inclusive.
ldaps Boolean: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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 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.
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
cacheTtl number: Cache expiry time in seconds.
headerType string: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
ldapPort number: An integer representing a port number between 0 and 65535, inclusive.
ldaps boolean: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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.

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.
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
cache_ttl float: Cache expiry time in seconds.
header_type str: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
ldap_port float: An integer representing a port number between 0 and 65535, inclusive.
ldaps bool: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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 fails with an authentication failure 4xx.
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
cacheTtl Number: Cache expiry time in seconds.
headerType String: An optional string to use as part of the Authorization header
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: A string representing a host name, such as example.com.
ldapPort Number: An integer representing a port number between 0 and 65535, inclusive.
ldaps Boolean: Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
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.

GetGatewayPluginLdapAuthOrdering

After GetGatewayPluginLdapAuthOrderingAfter
Before GetGatewayPluginLdapAuthOrderingBefore

After GetGatewayPluginLdapAuthOrderingAfter
Before GetGatewayPluginLdapAuthOrderingBefore

after GetGatewayPluginLdapAuthOrderingAfter
before GetGatewayPluginLdapAuthOrderingBefore

after GetGatewayPluginLdapAuthOrderingAfter
before GetGatewayPluginLdapAuthOrderingBefore

after GetGatewayPluginLdapAuthOrderingAfter
before GetGatewayPluginLdapAuthOrderingBefore

after Property Map
before Property Map

GetGatewayPluginLdapAuthOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginLdapAuthOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginLdapAuthRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginLdapAuthService

Id string

Id string

id String

id string

id str

id String

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginLdapAuth

On this page

On this page

Using getGatewayPluginLdapAuth

getGatewayPluginLdapAuth Result

Supporting Types

GetGatewayPluginLdapAuthConfig

GetGatewayPluginLdapAuthOrdering

GetGatewayPluginLdapAuthOrderingAfter

GetGatewayPluginLdapAuthOrderingBefore

GetGatewayPluginLdapAuthRoute

GetGatewayPluginLdapAuthService

Package Details

On this page

On this page