LdapConfiguration interface

LDAP configuration

Properties

bindAuthenticationLevel

The authentication level to use when binding to the LDAP server, defaults to Anonymous.

bindDN

The distinguished name (DN) to bind as when performing LDAP operations.

bindPasswordAkvConfig

The Azure Key Vault configuration where the Bind DN (Distinguished Name) user password is stored.

certificateCNHost

The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.

dnsServers

List of DNS server IPv4 addresses for resolving the CN host certificate. This parameter is used when LDAP over TLS is enabled.

domain

Name of the LDAP configuration domain

groupDN

This specifies the group DN (Distinguished Name), which overrides the base DN for group lookups.

ldapPort

Port number for LDAP communication. Default is 389 for LDAP.

ldapServers

List of LDAP server IP addresses (IPv4 only) for the LDAP domain.

netGroupDN

This specifies the netgroup DN (Distinguished Name), which overrides the base DN for netgroup lookups.

secureLdapType

Indicates the secure LDAP mode for encrypting communication between ANF storage and customer LDAP servers.

serverCACertificate

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.

userDN

This specifies the user DN (Distinguished Name), which overrides the base DN for user lookups.

Property Details

bindAuthenticationLevel

The authentication level to use when binding to the LDAP server, defaults to Anonymous.

bindAuthenticationLevel?: string

Property Value

string

bindDN

The distinguished name (DN) to bind as when performing LDAP operations.

bindDN?: string

Property Value

string

bindPasswordAkvConfig

The Azure Key Vault configuration where the Bind DN (Distinguished Name) user password is stored.

bindPasswordAkvConfig?: BindPasswordAkvConfig

Property Value

certificateCNHost

The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.

certificateCNHost?: string | null

Property Value

string | null

dnsServers

List of DNS server IPv4 addresses for resolving the CN host certificate. This parameter is used when LDAP over TLS is enabled.

dnsServers?: string[]

Property Value

string[]

domain

Name of the LDAP configuration domain

domain?: string

Property Value

string

groupDN

This specifies the group DN (Distinguished Name), which overrides the base DN for group lookups.

groupDN?: string

Property Value

string

ldapPort

Port number for LDAP communication. Default is 389 for LDAP.

ldapPort?: number

Property Value

number

ldapServers

List of LDAP server IP addresses (IPv4 only) for the LDAP domain.

ldapServers?: string[]

Property Value

string[]

netGroupDN

This specifies the netgroup DN (Distinguished Name), which overrides the base DN for netgroup lookups.

netGroupDN?: string

Property Value

string

secureLdapType

Indicates the secure LDAP mode for encrypting communication between ANF storage and customer LDAP servers.

secureLdapType?: string

Property Value

string

serverCACertificate

When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.

serverCACertificate?: string

Property Value

string

userDN

This specifies the user DN (Distinguished Name), which overrides the base DN for user lookups.

userDN?: string

Property Value

string