LdapAuthSettings

LdapAuthSettings

JSON Example

{
    "base_dn": "string",
    "bind_as_administrator": false,
    "email_attribute": "string",
    "full_name_attribute": "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"
    },
    "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 in Enterprise edition with any value, 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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

email_attribute

Optional

Constraints: default: email

LDAP attribute that refers to user email. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, 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 in Enterprise edition with any value, 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 in Enterprise edition with any value, 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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

LdapDirectorySettings

settings

Optional

settings

LdapUserBindSettings

user_bind

Optional

user_bind

Property Of

AuthProfile