LdapDirectorySettings

JSON Example

{
    "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"
}

string

admin_bind_dn

Required

LDAP Admin User DN. Administrator credentials are required to search for users under user search DN or groups under group search DN. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

group_filter

Optional

Constraints: default: (objectClass=*)

Group filter is used to identify groups during search. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

group_member_attribute

Optional

Constraints: default: member

LDAP group attribute that identifies each of the group members. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

group_member_is_full_dn

Optional

Constraints: default: true

Group member entries contain full DNs instead of just user id attribute values. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

group_search_dn

Optional

LDAP group search DN is the root of search for a given group in the LDAP directory. Only matching groups present in this LDAP directory sub-tree will be checked for user membership. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

group_search_scope

Optional

Constraints: default: AUTH_LDAP_SCOPE_SUBTREE

LDAP group search scope defines how deep to search for the group starting from the group search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

ignore_referrals

Optional

During user or group search, ignore searching referrals. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

password

Required

LDAP Admin User Password. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

user_attributes

Optional

LDAP user attributes to fetch on a successful user bind. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

user_id_attribute

Required

LDAP user id attribute is the login attribute that uniquely identifies a single user record. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

user_search_dn

Optional

LDAP user search DN is the root of search for a given user in the LDAP directory. Only user records present in this LDAP directory sub-tree will be validated. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

user_search_scope

Optional

Constraints: default: AUTH_LDAP_SCOPE_ONE

LDAP user search scope defines how deep to search for the user starting from user search DN. Enum options - AUTH_LDAP_SCOPE_BASE, AUTH_LDAP_SCOPE_ONE, AUTH_LDAP_SCOPE_SUBTREE. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of

LdapAuthSettings