Installation

If you are using database synchronization, you must publish the included migrations to add the following database columns to your users table:

Column Reason
guid This is for storing your LDAP users objectguid. It is needed for locating and synchronizing your LDAP user to the database.
domain This is for storing your LDAP users connection name. It is needed for storing your configured LDAP connection name of the user.

Publish the migration using the below command:

php artisan vendor:publish --provider="LdapRecord\Laravel\LdapAuthServiceProvider"

Then, add the following interface and trait to your app/User.php model:

  • Interface: LdapRecord\Laravel\Auth\LdapAuthenticatable
  • Trait: LdapRecord\Laravel\Auth\AuthenticatesWithLdap
<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use LdapRecord\Laravel\Auth\AuthenticatesWithLdap;
use LdapRecord\Laravel\Auth\LdapAuthenticatable;

class User extends Authenticatable implements LdapAuthenticatable
{
    use Notifiable, AuthenticatesWithLdap;

    // ...
}

This trait and interface provide LdapRecord the ability of setting and getting your users domain and guid database columns upon authentication.

Migration Customization

If you would like to customize the published migration and change the database columns, you must override the following methods in your Eloquent User model that are provided by the LdapRecord trait and interface:

// app/User.php

public function getLdapDomainColumn()
{
    return 'domain_column';
}

public function getLdapGuidColumn()
{
    return 'guid_column';
}
← Previous Topic

Overview

Next Topic →

Configuration