LdapAuthSettings

LdapAuthSettings
LdapAuthSettings
JSON Example
{
    "base_dn": "string",
    "bind_as_administrator": false,
    "client_cert_ref": "string",
    "email_attribute": "string",
    "full_name_attribute": "string",
    "pki_profile_ref": "string",
    "port": 0,
    "security_mode": "string",
    "server": [
        "string"
    ],
    "settings": {
        "admin_bind_dn": "string",
        "group_filter": "string",
        "group_member_attribute": "string",
        "group_member_is_full_dn": false,
        "group_search_dn": "string",
        "group_search_scope": "string",
        "ignore_referrals": false,
        "password": "string",
        "user_attributes": [
            "string"
        ],
        "user_id_attribute": "string",
        "user_search_dn": "string",
        "user_search_scope": "string"
    },
    "skip_hostname_verification": false,
    "user_bind": {
        "dn_template": "string",
        "token": "string",
        "user_attributes": [
            "string"
        ],
        "user_id_attribute": "string"
    }
}
string
base_dn
Optional

The LDAP base DN. For example, avinetworks.com would be DC=avinetworks,DC=com. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
bind_as_administrator
Optional
Constraints: default: true

LDAP administrator credentials are used to search for users and group memberships. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
client_cert_ref
Optional

Client certificate for mutual TLS connection. Effective only when security_mode is AUTH_LDAP_SECURE_USE_LDAPS. Not supported on the Service Engine data path, has no effect when this Auth Profile is used for Virtual Service client authentication. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
email_attribute
Optional
Constraints: default: email

LDAP attribute that refers to user email. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
full_name_attribute
Optional
Constraints: default: name

LDAP attribute that refers to user's full name. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
pki_profile_ref
Optional

PKI Profile used to validate the LDAP server certificate. Effective only when security_mode is AUTH_LDAP_SECURE_USE_LDAPS. It is a reference to an object of type PKIProfile. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
port
Optional
Constraints: default: 389

Query the LDAP servers on this port. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
security_mode
Required  
Constraints: default: AUTH_LDAP_SECURE_USE_LDAPS

LDAP connection security mode. Enum options - AUTH_LDAP_SECURE_NONE, AUTH_LDAP_SECURE_USE_LDAPS. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
server
Optional

LDAP server IP(v4/v6) address or FQDN. Use IP address if an auth profile is used to configure Virtual Service. Minimum of 1 items required. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

settings
Optional

settings

boolean
skip_hostname_verification
Optional

Skip hostname verification against the LDAP server certificate. The certificate chain is still validated using pki_profile_uuid. Effective only when security_mode is AUTH_LDAP_SECURE_USE_LDAPS. Not honored on the Service Engine data path, has no effect when this Auth Profile is used for Virtual Service client authentication. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

user_bind
Optional

user_bind

Property Of