Connectors

Active Directory Connector

The Active Directory connector enables user authentication against a Microsoft Active Directory or Windows Server domain. When configured, employees can log in to the captive portal and WPA2-Enterprise enrolment flows using their existing Windows domain credentials — no separate Kiwire password required. The connector performs an LDAP bind against the domain controller to validate credentials and retrieve user attributes.

'alt' => 'Dashboard overview', 'caption' => 'The default Kiwire dashboard layout', 'screenshot' => true, 'class' => '', ]) Drop images into: public/assets/img/docs/{page}/{filename} --}}
Image not uploaded yet public/assets/img/docs/connector-ad/overview.png
The Active Directory connector configuration — connection details, service account, and attribute mapping.

Use Cases

  • Corporate WiFi login — employees authenticate to the captive portal or WPA2-Enterprise SSID with their username@domain.com Windows credentials
  • Auto-provisioning — new employees are automatically created as Kiwire users on first successful AD authentication, without admin action
  • Attribute-driven policy — AD attributes like department or employeeType are mapped to Kiwire fields and can drive zone assignment or profile selection
  • Multi-domain support — configure multiple AD connector instances for different Windows domains within the same tenant

Configuration Fields

FieldDescription
nameInstance label to distinguish this AD connector from others (e.g., HQ Domain, Branch Office AD)
is_activeEnable or disable this connector instance without losing configuration
domain_controllerIP address or fully-qualified hostname of the domain controller (e.g., 192.168.1.10 or dc01.corp.example.com). For redundancy, you can specify a secondary DC separated by a comma.
account_suffixDomain suffix appended to the username entered by the user when performing the LDAP bind (e.g., @corp.example.com). Users type only their short username; the suffix is added automatically.
base_dnThe LDAP base distinguished name — the root of the directory tree from which Kiwire searches for user objects (e.g., DC=corp,DC=example,DC=com)
admin_usernameUPN of the service account used to bind to the directory for user lookup (e.g., svc-kiwire@corp.example.com). This account needs read-only access to the relevant OU — no elevated privileges are required.
admin_passwordPassword of the service account. Stored encrypted at rest using AES-256. Never logged or displayed after saving.
portLDAP port number. Default: 389 for standard LDAP, 636 for LDAPS (encrypted).
use_sslEnable LDAPS (LDAP over SSL/TLS). Requires a valid certificate on the domain controller. Strongly recommended for production environments.

Without LDAPS (use_ssl enabled), credentials transmitted during LDAP authentication are not encrypted. Enable LDAPS in any environment where Kiwire and the domain controller communicate over an untrusted network segment.

Attribute Mapping

The attribute mapping table tells Kiwire which AD attributes to read and store in the Kiwire user record when a user authenticates. Configure the mappings in the Advanced Configuration section of the connector form.

AD AttributeKiwire FieldNotes
mailemail_addressRecommended — used for email OTP and notifications
displayNamefullnameUser's full display name
telephoneNumberphone_numberUsed for SMS OTP if SMS connector is active
sAMAccountNameusernameShort Windows username (without domain suffix)
departmentdepartmentCan drive zone or profile auto-assignment rules
employeeIDemployee_idCorporate employee ID for cross-system reference
companycompanyUseful for multi-company tenants

Map at least mail and displayName as a baseline. These two attributes enable email notifications and a personalised portal welcome message without any additional configuration.

Testing the Connection

After saving the connector configuration, click Test Connection to verify that Kiwire can reach the domain controller and bind with the service account. The test performs a real LDAP bind — if the bind succeeds, a success banner is displayed with the number of users found in the base_dn scope.

You can also perform a User Lookup Test by entering a real username and password. This simulates the exact authentication path a user would take through the captive portal or enterprise journey, confirming that end-to-end authentication works before enabling the connector for production.

User Auto-Provisioning

When allow_create_account is enabled on the linked Enterprise Login Method or captive portal login method, Kiwire automatically creates a Kiwire user account the first time an AD user successfully authenticates. The new account is populated using the configured attribute mapping. Subsequent logins update the mapped attributes to reflect any changes in AD (e.g., a name change or new department).

If auto_activate is also enabled, the new account is immediately active and the user can connect without waiting for admin approval. Disable auto_activate in environments where new accounts require review before being granted WiFi access.

Multiple Instances

You can configure multiple Active Directory connector instances to support different Windows domains. Each instance is independent — separate domain controller, service account, base DN, and attribute mappings. Assign each instance to a different login method configuration so the correct domain is used for each SSID or journey.

If your organisation has a single-forest, multi-domain Active Directory, you can often use the forest root domain's Global Catalog port (3268 or 3269 for LDAPS) with the forest root's base DN. This allows a single connector instance to authenticate users from all child domains in the forest.

Required Permissions

view-connector-ad · edit-connector-ad