> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Laravel Socialite (authentification sociale)

> Implémentez rapidement le login social (GitHub, Google, Facebook…) via OAuth 2.0 avec Laravel Socialite.

## Qu'est-ce que Laravel Socialite

Laravel Socialite est le package officiel qui simplifie le login social via OAuth 2.0. Il prend en charge les principaux providers (GitHub, Google, Facebook, X (Twitter), LinkedIn…) et remplace une implémentation OAuth complexe par quelques lignes.

Providers intégrés :

| Provider          | Clé                      |
| ----------------- | ------------------------ |
| Bitbucket         | `bitbucket`              |
| Facebook          | `facebook`               |
| GitHub            | `github`                 |
| GitLab            | `gitlab`                 |
| Google            | `google`                 |
| LinkedIn (OpenID) | `linkedin-openid`        |
| Slack             | `slack` / `slack-openid` |
| Spotify           | `spotify`                |
| Twitch            | `twitch`                 |
| X (Twitter)       | `x`                      |

### Flux

```mermaid theme={null}
sequenceDiagram
    participant User as Utilisateur
    participant App as Application Laravel
    participant OAuth as GitHub (OAuth)
    participant DB as Base

    User->>App: Clique sur le bouton de connexion
    App->>OAuth: Redirection (Socialite::driver('github')->redirect())
    OAuth->>User: Écran d'autorisation
    User->>OAuth: Approuve
    OAuth->>App: Callback (paramètre code)
    App->>OAuth: Récupération du token
    OAuth-->>App: Informations utilisateur
    App->>DB: updateOrCreate
    DB-->>App: Enregistrement utilisateur
    App->>User: Login OK, redirection vers le dashboard
```

***

## Installation

```shell theme={null}
composer require laravel/socialite
```

<Info>
  Consultez le [guide de mise à jour](https://github.com/laravel/socialite/blob/master/UPGRADE.md) lors d'une montée de version majeure.
</Info>

***

## Configuration

### `config/services.php`

Ajoutez client ID, secret et URL de callback par provider.

```php theme={null}
// config/services.php

'github' => [
    'client_id' => env('GITHUB_CLIENT_ID'),
    'client_secret' => env('GITHUB_CLIENT_SECRET'),
    'redirect' => env('GITHUB_REDIRECT_URI'),
],

'google' => [
    'client_id' => env('GOOGLE_CLIENT_ID'),
    'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    'redirect' => env('GOOGLE_REDIRECT_URI'),
],

'facebook' => [
    'client_id' => env('FACEBOOK_CLIENT_ID'),
    'client_secret' => env('FACEBOOK_CLIENT_SECRET'),
    'redirect' => env('FACEBOOK_REDIRECT_URI'),
],
```

<Info>
  Un chemin relatif dans `redirect` est automatiquement résolu en URL complète.
</Info>

### `.env`

```ini theme={null}
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
GITHUB_REDIRECT_URI=https://example.com/auth/github/callback
```

Créez une OAuth App dans [GitHub Developer Settings](https://github.com/settings/developers) pour obtenir vos identifiants.

***

## Flux d'authentification

### Routing

Deux routes : redirection et callback.

```php theme={null}
use Laravel\Socialite\Facades\Socialite;

// Rediriger vers GitHub
Route::get('/auth/github', function () {
    return Socialite::driver('github')->redirect();
});

// Callback
Route::get('/auth/github/callback', function () {
    $user = Socialite::driver('github')->user();

    // $user->token pour l'access token
});
```

### Enregistrement + login

Dans le callback, enregistrez l'utilisateur puis connectez-le.

```php theme={null}
use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Laravel\Socialite\Facades\Socialite;

Route::get('/auth/github/callback', function () {
    $githubUser = Socialite::driver('github')->user();

    $user = User::updateOrCreate(
        ['github_id' => $githubUser->id],
        [
            'name' => $githubUser->name,
            'email' => $githubUser->email,
            'github_token' => $githubUser->token,
            'github_refresh_token' => $githubUser->refreshToken,
        ]
    );

    Auth::login($user);

    return redirect('/dashboard');
});
```

<Warning>
  `updateOrCreate` nécessite la colonne `github_id` sur la table `users`. Voir la migration ci-après.
</Warning>

***

## Récupérer les informations utilisateur

Sur l'objet retourné par `user()` :

```php theme={null}
Route::get('/auth/github/callback', function () {
    $user = Socialite::driver('github')->user();

    // OAuth 2
    $token = $user->token;
    $refreshToken = $user->refreshToken;
    $expiresIn = $user->expiresIn;

    // OAuth 1 (X…)
    $token = $user->token;
    $tokenSecret = $user->tokenSecret;

    // Commun
    $user->getId();
    $user->getNickname();
    $user->getName();
    $user->getEmail();
    $user->getAvatar();
});
```

### Depuis un access token existant

```php theme={null}
$user = Socialite::driver('github')->userFromToken($token);
```

### Mode stateless

Pour une API sans cookies de session, `stateless()` désactive la vérification d'état.

```php theme={null}
return Socialite::driver('google')->stateless()->user();
```

***

## Intégration DB

### Migration

Ajoutez les colonnes de login social.

```php theme={null}
// database/migrations/xxxx_xx_xx_add_github_columns_to_users_table.php

return new class extends Migration
{
    public function up(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('github_id')->nullable()->unique()->after('id');
            $table->string('github_token')->nullable()->after('github_id');
            $table->string('github_refresh_token')->nullable()->after('github_token');
        });
    }

    public function down(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn(['github_id', 'github_token', 'github_refresh_token']);
        });
    }
};
```

### Colonnes `provider` pour plusieurs providers

```php theme={null}
Schema::table('users', function (Blueprint $table) {
    $table->string('provider')->nullable()->after('id');
    $table->string('provider_id')->nullable()->after('provider');
    $table->string('provider_token')->nullable()->after('provider_id');

    $table->unique(['provider', 'provider_id']);
});
```

Callback dynamique :

```php theme={null}
Route::get('/auth/{provider}/callback', function (string $provider) {
    $socialUser = Socialite::driver($provider)->user();

    $user = User::updateOrCreate(
        [
            'provider' => $provider,
            'provider_id' => $socialUser->getId(),
        ],
        [
            'name' => $socialUser->getName(),
            'email' => $socialUser->getEmail(),
            'provider_token' => $socialUser->token,
        ]
    );

    Auth::login($user);

    return redirect('/dashboard');
});
```

### Rattachement à un utilisateur existant

Cherchez par e-mail avant de créer.

```php theme={null}
$socialUser = Socialite::driver('github')->user();

$user = User::where('email', $socialUser->getEmail())->first();

if ($user) {
    $user->update([
        'github_id' => $socialUser->getId(),
        'github_token' => $socialUser->token,
    ]);
} else {
    $user = User::create([
        'name' => $socialUser->getName(),
        'email' => $socialUser->getEmail(),
        'github_id' => $socialUser->getId(),
        'github_token' => $socialUser->token,
    ]);
}

Auth::login($user);
```

***

## Scopes et options

### Scopes

```php theme={null}
return Socialite::driver('github')
    ->scopes(['read:user', 'public_repo'])
    ->redirect();
```

`setScopes()` remplace complètement les scopes.

```php theme={null}
return Socialite::driver('github')
    ->setScopes(['read:user', 'public_repo'])
    ->redirect();
```

### Paramètres optionnels

`with()` ajoute des paramètres à la redirection.

```php theme={null}
// Restriction de domaine Google
return Socialite::driver('google')
    ->with(['hd' => 'example.com'])
    ->redirect();

// Afficher systématiquement l'écran de consentement
return Socialite::driver('google')
    ->with(['prompt' => 'consent'])
    ->redirect();
```

<Warning>
  N'utilisez pas `with()` pour des mots-clés réservés comme `state` ou `response_type`.
</Warning>

### Token bot Slack

Pour un token bot Slack, `asBotUser()`.

```php theme={null}
return Socialite::driver('slack')
    ->asBotUser()
    ->setScopes(['chat:write', 'chat:write.public', 'chat:write.customize'])
    ->redirect();

$user = Socialite::driver('slack')->asBotUser()->user();
```

***

## Tests

Socialite propose un moteur de mock.

### Redirection

```php theme={null}
use Laravel\Socialite\Facades\Socialite;

test('redirige vers GitHub', function () {
    Socialite::fake('github');

    $response = $this->get('/auth/github');

    $response->assertRedirect();
});
```

### Callback

`User::fake()` crée un utilisateur factice.

```php theme={null}
use Laravel\Socialite\Facades\Socialite;
use Laravel\Socialite\Two\User;

test('login via GitHub', function () {
    Socialite::fake('github', User::fake([
        'id' => 'github-123',
        'name' => 'Jane Doe',
        'email' => 'jane@example.com',
    ]));

    $response = $this->get('/auth/github/callback');

    $response->assertRedirect('/dashboard');

    $this->assertDatabaseHas('users', [
        'name' => 'Jane Doe',
        'email' => 'jane@example.com',
        'github_id' => 'github-123',
    ]);
});
```

Par défaut, un token factice est fourni. Vous pouvez surcharger.

```php theme={null}
$fakeUser = User::fake([
    'id' => 'github-123',
    'name' => 'Jane Doe',
    'email' => 'jane@example.com',
    'token' => 'fake-token',
    'refreshToken' => 'fake-refresh-token',
    'expiresIn' => 3600,
    'approvedScopes' => ['read:user', 'public_repo'],
]);
```

Pour OAuth 1, utilisez `Laravel\Socialite\One\User`.

***

## Provider personnalisé

Utilisez `Socialite::extend()` pour ajouter un driver. `SocialiteManager` hérite de `Illuminate\Support\Manager`, comme les autres systèmes de driver Laravel.

<Info>
  Voir aussi [Classe Manager](/fr/advanced/manager) pour le pattern et `extend()`.
</Info>

### 1. Classe du provider

Héritez de `Laravel\Socialite\Two\AbstractProvider` et implémentez 4 méthodes.

```php theme={null}
// app/Socialite/ExampleProvider.php

namespace App\Socialite;

use Laravel\Socialite\Two\AbstractProvider;
use Laravel\Socialite\Two\User;

class ExampleProvider extends AbstractProvider
{
    // URL d'autorisation (où rediriger l'utilisateur)
    public function getAuthUrl($state): string
    {
        return $this->buildAuthUrlFromBase('https://example.com/oauth/authorize', $state);
    }

    // URL pour obtenir le token
    protected function getTokenUrl(): string
    {
        return 'https://example.com/oauth/token';
    }

    // Récupérer l'utilisateur via le token
    protected function getUserByToken($token): array
    {
        $response = $this->getHttpClient()->get('https://example.com/api/user', [
            'headers' => ['Authorization' => 'Bearer '.$token],
        ]);

        return json_decode($response->getBody(), true);
    }

    // Mapper le tableau vers un User Socialite
    protected function mapUserToObject(array $user): User
    {
        return (new User)->setRaw($user)->map([
            'id'       => $user['id'],
            'nickname' => $user['login'] ?? null,
            'name'     => $user['name'],
            'email'    => $user['email'],
            'avatar'   => $user['avatar_url'] ?? null,
        ]);
    }
}
```

Rôle des 4 méthodes :

| Méthode                        | Rôle                                      |
| ------------------------------ | ----------------------------------------- |
| `getAuthUrl($state)`           | URL de redirection OAuth                  |
| `getTokenUrl()`                | Endpoint d'échange code → token           |
| `getUserByToken($token)`       | Récupère les infos utilisateur en tableau |
| `mapUserToObject(array $user)` | Convertit en `User` Socialite             |

### 2. Enregistrement dans le service provider

Dans `boot()` de `AppServiceProvider`.

```php theme={null}
// app/Providers/AppServiceProvider.php

use App\Socialite\ExampleProvider;
use Laravel\Socialite\Facades\Socialite;

public function boot(): void
{
    Socialite::extend('example', function ($app) {
        $config = $app['config']['services.example'];

        return Socialite::buildProvider(ExampleProvider::class, $config);
    });
}
```

### 3. Ajouter la configuration

```php theme={null}
// config/services.php
'example' => [
    'client_id'     => env('EXAMPLE_CLIENT_ID'),
    'client_secret' => env('EXAMPLE_CLIENT_SECRET'),
    'redirect'      => env('EXAMPLE_REDIRECT_URI'),
],
```

### 4. Utilisation standard

```php theme={null}
// Redirection
Route::get('/auth/example', function () {
    return Socialite::driver('example')->redirect();
});

// Callback
Route::get('/auth/example/callback', function () {
    $user = Socialite::driver('example')->user();
});
```

<Tip>
  Vous pouvez également utiliser des packages tiers qui étendent Socialite de manière propre via `extend()`.
</Tip>

***

## Packages associés

Extensions Socialite publiées par le propriétaire de ce site, implémentées correctement via `Socialite::extend()`.

<CardGroup cols={2}>
  <Card title="LINE" icon="comment" href="https://github.com/invokable/laravel-line-sdk">
    SDK LINE : Socialite + Messaging API.
  </Card>

  <Card title="Bluesky" icon="cloud" href="https://github.com/invokable/laravel-bluesky">
    Intégration AT Protocol : OAuth + publication.
  </Card>

  <Card title="Discord" icon="discord" href="https://github.com/invokable/socialite-discord">
    OAuth2 Discord.
  </Card>

  <Card title="Threads" icon="instagram" href="https://github.com/invokable/laravel-threads">
    OAuth + API de publication Meta Threads.
  </Card>

  <Card title="Amazon" icon="amazon" href="https://github.com/invokable/socialite-amazon">
    Login with Amazon.
  </Card>

  <Card title="Mastodon" icon="mastodon" href="https://github.com/invokable/socialite-mastodon">
    OAuth vers une instance Mastodon.
  </Card>

  <Card title="WordPress" icon="wordpress" href="https://github.com/invokable/socialite-wordpress">
    WordPress.com et WordPress auto-hébergé.
  </Card>
</CardGroup>


## Related topics

- [Socialite for Discord](/fr/packages/socialite-discord.md)
- [Kits de démarrage](/fr/starter-kits.md)
- [Socialite - Laravel Bluesky](/fr/packages/laravel-bluesky/socialite.md)
- [Comparaison des méthodes d'authentification - Laravel Bluesky](/fr/packages/laravel-bluesky/authentication.md)
- [Socialite (LINE Login) - LINE SDK for Laravel](/fr/packages/laravel-line-sdk/socialite.md)