AD/LDAP Realm

Version:

Location in GUI: Integrations » Realms » Active Directory/LDAP

Diagram

Classes

integrations (fmc.domains)

Name	Type	Constraint	Mandatory	Default Value
ad_ldap_realms	List	`[ad_ldap_realms]`	No

ad_ldap_realms (fmc.domains.integrations)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
realm_type	Choice	`AD`, `LDAP`	Yes
base_dn	String		Yes
group_dn	String		Yes
directory_username	String		Yes
directory_password	String		Yes
directory_servers	List	`[directory_servers]`	Yes
ad_join_password	String		No
ad_join_username	String		No
ad_primary_domain	String		No
description	String	max: `255`	No
enabled	Boolean	`true`, `false`	No	`true`
excluded_groups	List	String	No
excluded_users	List	String	No
group_attribute	Any	Choice[`uniqueMember`, `member`] or String	No	`uniqueMember`
included_groups	List	String	No
included_users	List	String	No
timeout_captive_portal_users	Integer	min: `0`, max: `35791394`	No	`1440`
timeout_failed_captive_portal_users	Integer	min: `0`, max: `35791394`	No	`1440`
timeout_guest_captive_portal_users	Integer	min: `0`, max: `35791394`	No	`1440`
timeout_ise_and_passive_indentity_users	Integer	min: `0`, max: `35791394`	No	`1440`
timeout_terminal_server_agent_users	Integer	min: `0`, max: `35791394`	No	`1440`
update_hour	Integer	min: `0`, max: `23`	No	0
update_interval	Choice	`1`, `2`, `3`, `4`, `6`, `8`, `12`, `24`	No	`24`

directory_servers (fmc.domains.integrations.ad_ldap_realms)

Name	Type	Constraint	Mandatory
hostname	String		Yes
port	Integer	min: `1`, max: `65535`	Yes
encryption_protocol	Choice	`NONE`, `LDAPS`, `STARTTLS`	Yes
ca_certificate	String		No
interface_group	String		No
use_routing_to_select_interface	Boolean	`true`, `false`	No

Examples

fmc:
  domains:
    - name: Global
      integrations:
        ad_ldap_realms:
          - name: MyADLDAPRealmName1
            realm_type: LDAP
            base_dn: "dc=example,dc=com"
            group_dn: "ou=Groups,dc=example,dc=com"
            directory_username: DirectoryUser
            directory_password: DirectoryPassword
            directory_servers:
              - hostname: ldap1.example.com
                port: 389
                encryption_protocol: NONE
              - hostname: ldap2.example.com
                port: 389
                encryption_protocol: NONE