Laravel Socialite

https://github.com/laravel/socialite
Admin
Laravel Socialite is a PHP package for Laravel that adds OAuth 1 and OAuth 2 social login with...
Tokens:57,952
Snippets:521
Trust Score:9.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Callback route example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Example of handling OAuth callback and logging in the user.

```php
Route::get('/auth/github/callback', function () {
    $user = Socialite::driver('github')->user(); // Two\User with token set

    Auth::loginUsingId($user->getId());
});
```

--------------------------------

### Slack asBotUser usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-linkedin-slack.md

Shows how to use the asBotUser method to get a bot token instead of a user token.

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

--------------------------------

### refreshToken example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Example of refreshing a token and accessing its properties.

```php
$token = Socialite::driver('github')->refreshToken($user->refreshToken);

// $token->token, $token->refreshToken, $token->expiresIn, $token->approvedScopes
```

--------------------------------

### buildProvider() usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Example of building a GithubProvider with a config array. The redirect is resolved to an absolute URL, and scopes are merged with provider defaults.

```php
use Laravel\Socialite\SocialiteManager;

$manager = app(Laravel\Socialite\Contracts\Factory::class);

$provider = $manager->buildProvider(
    Laravel\Socialite\Two\GithubProvider::class,
    [
        'client_id' => 'abc',
        'client_secret' => 'def',
        'redirect' => '/auth/github/callback', // resolved to absolute URL
        'scopes' => ['user:email', 'read:org'],
    ]
);
```

--------------------------------

### userFromToken example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Example of retrieving a user from a stored access token.

```php
$user = Socialite::driver('google')->userFromToken($storedAccessToken);
```

--------------------------------

### Redirect example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Example of initiating OAuth redirect with Socialite driver.

```php
return Socialite::driver('github')->redirect();
```

--------------------------------

### Usage example for getAccessToken and userFromToken

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-github-gitlab-bitbucket.md

Shows how to obtain an access token and then fetch the user using that token.

```php
$token = Socialite::driver('bitbucket')->getAccessToken($code);

$user = Socialite::driver('bitbucket')->userFromToken($token);
```

--------------------------------

### InvalidStateException handling

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Example of catching InvalidStateException and redirecting back to start.

```php
try {
    $user = Socialite::driver('github')->user();
} catch (\Laravel\Socialite\Two\InvalidStateException $e) {
    return redirect('/auth/redirect'); // state mismatch or empty session state
}
```

--------------------------------

### X driver usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-twitter-x-twitch.md

Shows how to retrieve a user with the 'x' driver (alias 'x-oauth-2').

```php
// Driver name: 'x' (alias 'x-oauth-2')
$user = Socialite::driver('x')->user();
```

--------------------------------

### enablePKCE() signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Enables PKCE. When enabled, the redirect stores a code_verifier in the session. This snippet shows the method signature and an example with LinkedIn.

```php
public function enablePKCE()
```

```php
$user = Socialite::driver('linkedin')->enablePKCE()->user();
```

--------------------------------

### setScopes($scopes) signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Replaces the entire scope set. The method signature is shown first, followed by an example that sets the scopes to ['repo'].

```php
public function setScopes($scopes)
```

```php
$provider = Socialite::driver('github')->setScopes(['repo']);
```

--------------------------------

### scopes($scopes) signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Adds scopes to the existing set. The method signature is shown first, followed by an example that merges the given scopes.

```php
public function scopes($scopes)
```

```php
$provider = Socialite::driver('github')->scopes(['read:org', 'repo']);
```

--------------------------------

### GitLab service configuration

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-github-gitlab-bitbucket.md

Example configuration for services.php to set up the GitLab provider, including optional host setting.

```php
// config/services.php
'gitlab' => [
    'client_id' => env('GITLAB_CLIENT_ID'),
    'client_secret' => env('GITLAB_CLIENT_SECRET'),
    'redirect' => env('GITLAB_REDIRECT_URI'),
    'host' => env('GITLAB_HOST'), // optional, defaults to https://gitlab.com
],
```

--------------------------------

### forgetDrivers() usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Example of clearing cached drivers so the next driver() call rebuilds providers.

```php
$manager->forgetDrivers(); // next driver() calls rebuild providers
```

--------------------------------

### Twitter driver with stateless and PKCE

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-twitter-x-twitch.md

Example showing stateless mode with PKCE enabled automatically for the Twitter driver.

```php
// PKCE is enabled automatically for this driver; stateless + PKCE also works:
$user = Socialite::driver('twitter')
    ->stateless()
    ->user();
```

--------------------------------

### User::fake() usage examples

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-user.md

Shows how to create a fake user with custom attributes or with all defaults. The second example uses the fake user with Socialite::fake().

```php
use Laravel\Socialite\Two\User;

$user = User::fake([
    'id' => '42',
    'email' => 'dev@example.com',
    'token' => 'abc123',
]);

$user = User::fake(); // all defaults
```

```php
Socialite::fake('google', User::fake(['id' => 'google-id-1']));

$user = Socialite::driver('google')->user(); // the fake
```

--------------------------------

### Testing GitHub authentication with Socialite::fake

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-facade.md

Example test that creates a fake user, calls Socialite::fake('github', $fakeUser), and then hits the callback route. The controller can then use Socialite::driver('github')->user() to get the fake user.

```php
use Laravel\Socialite\Facades\Socialite;

public function test_a_user_can_authenticate_with_github()
{
    $fakeUser = (new \Laravel\Socialite\Two\User)->map([
        'id' => '123456789',
        'nickname' => 'taylor',
        'name' => 'Taylor Otwell',
        'email' => 'taylor@example.com',
        'avatar' => 'https://avatars.example.com/taylor.png',
    ]);

    Socialite::fake('github', $fakeUser);

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

    // The controller can now do Socialite::driver('github')->user() and get $fakeUser.
}
```

--------------------------------

### GithubProvider usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-github-gitlab-bitbucket.md

Shows how to retrieve a GitHub user and access common fields like id, nickname, and nodeId.

```php
$user = Socialite::driver('github')->user();

$user->getId();        // numeric GitHub id
$user->getNickname();  // login
$user->nodeId;         // node_id (dynamic attribute)
```

--------------------------------

### setHttpClient(Client $client) signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Injects a custom GuzzleHttp client. The method signature is shown first, followed by an example that creates a client with timeout and proxy options.

```php
public function setHttpClient(Client $client)
```

```php
use GuzzleHttp\Client;

$provider->setHttpClient(new Client([
    'timeout' => 10,
    'proxy' => 'http://proxy.example.com:8080',
]));
```

--------------------------------

### with(array $parameters) signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Sets custom parameters merged into both authorization and token fields, overriding same-named defaults. The method signature is shown first, followed by an example with Google.

```php
public function with(array $parameters)
```

```php
$user = Socialite::driver('google')
    ->with(['prompt' => 'select_account', 'access_type' => 'offline'])
    ->user();
```

--------------------------------

### Token usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-user.md

Shows how to refresh a token and update user properties. Note that missing fields in the provider response can cause TypeError due to type hints.

```php
$token = Socialite::driver('google')->refreshToken($user->refreshToken);

$user->setToken($token->token)
     ->setRefreshToken($token->refreshToken)
     ->setExpiresIn($token->expiresIn);
```

--------------------------------

### TwitterProvider::scope() usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/one-providers.md

Example of setting the scope to 'read' using the Socialite facade.

```php
Socialite::driver('twitter')->scope('read');
```

--------------------------------

### redirect()

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Starts the OAuth flow by storing state and PKCE verifier if enabled, then redirects to the authorization URL.

```APIDOC
## redirect()

### Description
Starts the OAuth flow. If state is used, stores `Str::random(40)` under `state` in the session; if PKCE is enabled, stores the code verifier (`Str::random(96)`) under `code_verifier`. Returns a redirect to `getAuthUrl($state)`.

### Method
redirect

### Signature
```php
public function redirect()
```

### Returns
`Illuminate\Http\RedirectResponse`

### Example
```php
return Socialite::driver('github')->redirect();
```
```

--------------------------------

### Closure user example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Shows how to fake a driver with a closure that returns a fake user. The closure is invoked when the driver's user() method is called.

```php
Socialite::fake('google', function () {
    return User::fake(['id' => 'google-1']);
});

// $user = Socialite::driver('google')->user(); // User::fake(['id' => 'google-1'])
```

--------------------------------

### User::fake() usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/one-providers.md

Example of calling fake() with an override for the id attribute.

```php
$user = \Laravel\Socialite\One\User::fake(['id' => 'twitter-id']);
```

--------------------------------

### with($driver)

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Alias for driver($driver) to get a driver instance by name.

```APIDOC
## with($driver)

### Description
Alias for `driver($driver)` — get a driver instance by name.

### Method
`with`

### Parameters
- `$driver` (string) - Required - Driver name, e.g. `'github'`, `'twitter'`

### Returns
mixed — the resolved provider (a `Contracts\Provider`; concrete type depends on the driver).
```

--------------------------------

### Slack driver usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-linkedin-slack.md

Shows how to retrieve a user with the 'slack' driver and access the Slack user id and organization_id dynamic attribute.

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

$user->getId();            // Slack user id
$user->organization_id;    // team id (dynamic attribute)
```

--------------------------------

### Usage example: faking GitHub driver with user

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Shows how to fake the 'github' driver with a fake user in a test. The fake user is returned by the driver's user() method, and redirect() returns a RedirectResponse to the fake URL.

```php
use Laravel\Socialite\Facades\Socialite;
use Laravel\Socialite\Two\User;

public function test_callback_creates_account()
{
    Socialite::fake('github', User::fake(['id' => '42', 'email' => 'dev@example.com']));

    // controller code under test:
    $githubUser = Socialite::driver('github')->user(); // the User::fake instance

    Socialite::driver('github')->redirect(); // RedirectResponse to https://socialite.fake/github/authorize
}
```

--------------------------------

### Twitch driver usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-twitter-x-twitch.md

Shows how to retrieve a user with the 'twitch' driver and access the numeric id and email (requires user:read:email scope).

```php
$user = Socialite::driver('twitch')->user();

$user->getId();     // Twitch numeric user id
$user->getEmail();  // requires the user:read:email scope
```

--------------------------------

### LinkedIn user retrieval example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-linkedin-slack.md

Example of using Socialite to retrieve a LinkedIn user and access profile fields.

```php
$user = Socialite::driver('linkedin')->user();

$user->first_name;  // "Taylor"
$user->last_name;   // "Otwell"
$user->getName();   // "Taylor Otwell"
$user->getEmail();
```

--------------------------------

### LinkedIn OpenID driver usage example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-linkedin-slack.md

Shows how to retrieve a user with the 'linkedin-openid' driver and access the sub claim and email_verified dynamic attribute.

```php
// Driver name: 'linkedin-openid'
$user = Socialite::driver('linkedin-openid')->user();

$user->getId();          // sub claim
$user->email_verified;   // dynamic attribute
```

--------------------------------

### map() method and usage

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/abstract-user.md

Stores attributes and assigns them to existing properties. The example maps id, nickname, and a dynamic avatar_original key.

```php
public function map(array $attributes)
```

```php
$user->map([
    'id' => '123',
    'nickname' => 'taylor',
    'avatar_original' => 'https://...', // dynamic — readable via __get
]);
```

--------------------------------

### stateless() signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Disables session state validation and storage. The method signature is shown first, followed by an example for API clients without session support.

```php
public function stateless()
```

```php
// API clients without session support:
$user = Socialite::driver('google')->stateless()->user();
```

--------------------------------

### Google driver user and refreshToken usage

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-google-facebook.md

Example showing how to retrieve a user via the Google driver and then refresh the token if a refresh token is present.

```php
$user = Socialite::driver('google')->user();
if ($user->refreshToken) {
    $refreshed = Socialite::driver('google')->refreshToken($user->refreshToken);
}
```

--------------------------------

### Using userFromTokenAndSecret

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/one-providers.md

Example usage of userFromTokenAndSecret to retrieve a user from stored token and secret.

```php
$user = Socialite::driver('twitter')->userFromTokenAndSecret($token, $secret);
```

--------------------------------

### redirectUrl($url) signature and example

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Overrides the redirect URL sent in auth and token requests. The method signature is shown first, followed by an example using Google and a route callback.

```php
public function redirectUrl($url)
```

```php
Socialite::driver('google')->redirectUrl(route('google.callback'));
```

--------------------------------

### Configure Socialite providers in config/services.php

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/configuration.md

Example configuration for Laravel Socialite providers in config/services.php. Shows required client_id, client_secret, and redirect keys for GitHub, Google, GitLab, Twitter, and X. Includes commented guzzle and scopes options for GitHub, optional host for GitLab, and oauth key for Twitter to select OAuth 2.

```php
<?php

return [

    'github' => [
        'client_id' => env('GITHUB_CLIENT_ID'),
        'client_secret' => env('GITHUB_CLIENT_SECRET'),
        'redirect' => env('GITHUB_REDIRECT_URI'),
        // 'guzzle' => ['timeout' => 15, 'verify' => false],
        // 'scopes' => ['read:org'],
    ],

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

    'gitlab' => [
        'client_id' => env('GITLAB_CLIENT_ID'),
        'client_secret' => env('GITLAB_CLIENT_SECRET'),
        'redirect' => env('GITLAB_REDIRECT_URI'),
        'host' => env('GITLAB_HOST'), // optional
    ],

    'twitter' => [
        'client_id' => env('TWITTER_CLIENT_ID'),
        'client_secret' => env('TWITTER_CLIENT_SECRET'),
        'redirect' => env('TWITTER_REDIRECT_URI'),
        'oauth' => 2, // OAuth 2. Omit (or use any other value) for OAuth 1
    ],

    'x' => [
        'client_id' => env('X_CLIENT_ID'),
        'client_secret' => env('X_CLIENT_SECRET'),
        'redirect' => env('X_REDIRECT_URI'),
    ],

];
```

--------------------------------

### with() method signature

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Alias for driver($driver) to get a driver instance by name. The $driver parameter is a string like 'github' or 'twitter'. Returns the resolved provider, which is a Contracts\Provider instance.

```php
public function with($driver)
```

--------------------------------

### Type-hint Provider contract to accept any driver

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/contracts.md

Use this snippet to type-hint the Provider contract in a callback, allowing any Socialite driver (including fakes) to be passed. The example shows a function that returns the user from the provider, with a commented call using the 'google' driver.

```php
use Laravel\Socialite\Contracts\Provider;
use Laravel\Socialite\Contracts\User;

function handleProviderCallback(Provider $provider): ?User
{
    return $provider->user();
}

// handleProviderCallback(Socialite::driver('google'));
```

--------------------------------

### Register custom driver with Socialite::extend

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Registers a custom Socialite driver named 'spotify' using the extend method. The callback receives the application container and should return a provider instance, typically built via buildProvider with a custom provider class and configuration from config('services.spotify'). The example shows commented-out lines for clarity.

```php
use Laravel\Socialite\Two\AbstractProvider;
use Laravel\Socialite\Contracts\Provider;

Socialite::extend('spotify', function ($app) {
    // $config = config('services.spotify');
    return app(Laravel\Socialite\Contracts\Factory::class)
        // ->buildProvider(SpotifyProvider::class, $config);
});
```

--------------------------------

### __get() method and usage

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/abstract-user.md

Magic getter for dynamic attributes. The example shows retrieving a LinkedIn user and accessing dynamic attributes via __get and ArrayAccess.

```php
public function __get($key)
```

```php
$user = Socialite::driver('linkedin')->user();

$user->first_name;  // dynamic attribute from map() output
$user['id'];        // ArrayAccess over raw payload
isset($user['id']); // raw key exists
```

--------------------------------

### Constructor

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Initializes the provider with request, client credentials, redirect URL, and optional Guzzle options.

```APIDOC
## Constructor

### Description
Initializes the provider with the current request, OAuth client credentials, redirect URL, and optional Guzzle client options.

### Method
Constructor

### Signature
```php
public function __construct(Request $request, $clientId, $clientSecret, $redirectUrl, $guzzle = [])
```

### Parameters
- `$request` (Illuminate\Http\Request) - Required - Current request (source of `code`, `state`, session)
- `$clientId` (string) - Required - OAuth client ID
- `$clientSecret` (string) - Required - OAuth client secret
- `$redirectUrl` (string) - Required - Callback URI sent to the provider
- `$guzzle` (array) - Optional - Options passed to `new Client($this->guzzle)`

### Notes
Normally you never call this directly — `SocialiteManager::buildProvider()` does.
```

--------------------------------

### enablePKCE()

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Enables PKCE flow, adding code_challenge and code_verifier handling.

```APIDOC
## enablePKCE()

### Description
Sets $this->usesPKCE = true. When enabled, redirect() stores a code_verifier in the session; the auth URL gains code_challenge (S256 of the verifier) and code_challenge_method=S256; the token request sends code_verifier (pulled from the session).

### Method
enablePKCE

### Signature
public function enablePKCE()

### Returns
$this (fluent)

### Example
```php
$user = Socialite::driver('linkedin')->enablePKCE()->user();
```
```

--------------------------------

### Typical Usage of Socialite Facade

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-facade.md

Shows how to use the facade to redirect to a provider (GitHub) and handle the callback, retrieving user details.

```php
use Laravel\Socialite\Facades\Socialite;

// Redirect to provider
Route::get('/auth/redirect', fn () => Socialite::driver('github')->redirect());

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

    // $githubUser->getId(), getName(), getEmail(), getAvatar(), getRaw() ...
});

```

--------------------------------

### buildProvider() missing config exception

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Shows the exception thrown when required configuration keys are missing. The error message lists the missing keys and the provider class.

```php
try {
    $manager->buildProvider(\Laravel\Socialite\Two\GithubProvider::class, ['client_id' => 'abc']);
} catch (\Laravel\Socialite\Exceptions\DriverMissingConfigurationException $e) {
    // "Missing required configuration keys [client_secret, redirect] for [Laravel\...\GithubProvider] OAuth provider."
}
```

--------------------------------

### offsetGet() method

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/abstract-user.md

Gets a value from the raw payload.

```php
#[\ReturnTypeWillChange]
public function offsetGet($offset)
```

--------------------------------

### Socialite::getScopes

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-facade.md

Static method on the Socialite facade to get the current scopes.

```APIDOC
## Socialite::getScopes()

### Description
Returns the current scopes for the default driver. This method is forwarded to the underlying `SocialiteManager`.

### Method
`Socialite::getScopes`

### Returns
array - The list of scopes.
```

--------------------------------

### GET https://slack.com/api/users.identity

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Slack user's identity information.

```APIDOC
## GET https://slack.com/api/users.identity

### Description
Retrieves the authenticated Slack user's identity information.

### Method
GET

### Endpoint
https://slack.com/api/users.identity

### Parameters
#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **user** (object) - User object
  - **id** (string) - User ID
  - **name** (string) - Username
  - **email** (string) - Email address

#### Response Example
{
  "user": {
    "id": "U123456",
    "name": "johndoe",
    "email": "john@example.com"
  }
}
```

--------------------------------

### GET {host}/api/v3/user

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated GitLab user's profile information.

```APIDOC
## GET {host}/api/v3/user

### Description
Retrieves the authenticated GitLab user's profile information.

### Method
GET

### Endpoint
{host}/api/v3/user

### Parameters
#### Path Parameters
- **host** (string) - Required - GitLab instance host (e.g., https://gitlab.com)

#### Query Parameters
- **access_token** (string) - Required - Access token (in URL, not header)

### Response
#### Success Response (200)
- **id** (integer) - User ID
- **username** (string) - Username
- **name** (string) - Display name
- **email** (string) - Email address

#### Response Example
{
  "id": 123,
  "username": "johndoe",
  "name": "John Doe",
  "email": "john@example.com"
}
```

--------------------------------

### GET https://api.bitbucket.org/2.0/user

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Bitbucket user's profile information.

```APIDOC
## GET https://api.bitbucket.org/2.0/user

### Description
Retrieves the authenticated Bitbucket user's profile information.

### Method
GET

### Endpoint
https://api.bitbucket.org/2.0/user

### Parameters
#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **uuid** (string) - User UUID
- **username** (string) - Username
- **display_name** (string) - Display name
- **links** (object) - Links to user resources

#### Response Example
{
  "uuid": "{abc123}",
  "username": "johndoe",
  "display_name": "John Doe",
  "links": {
    "self": {
      "href": "https://api.bitbucket.org/2.0/users/johndoe"
    }
  }
}
```

--------------------------------

### GET https://api.linkedin.com/v2/emailAddress

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated LinkedIn user's email address.

```APIDOC
## GET https://api.linkedin.com/v2/emailAddress

### Description
Retrieves the authenticated LinkedIn user's email address.

### Method
GET

### Endpoint
https://api.linkedin.com/v2/emailAddress

### Parameters
#### Query Parameters
- **q** (string) - Required - Must be `members`
- **projection** (string) - Required - Must be `(elements*(handle~))`

#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`
- **X-RestLi-Protocol-Version** (string) - Required - Must be `2.0.0`

### Response
#### Success Response (200)
- **elements** (array) - Array of email elements
  - **handle~** (object) - Email address data

#### Response Example
{
  "elements": [
    {
      "handle~": {
        "emailAddress": "john@example.com"
      }
    }
  ]
}
```

--------------------------------

### GET https://api.linkedin.com/v2/me

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated LinkedIn user's profile information.

```APIDOC
## GET https://api.linkedin.com/v2/me

### Description
Retrieves the authenticated LinkedIn user's profile information.

### Method
GET

### Endpoint
https://api.linkedin.com/v2/me

### Parameters
#### Query Parameters
- **projection** (string) - Required - Projection expression. Default: `(id,firstName,lastName,profilePicture(displayImage~:playableStreams)[,vanityName])`

#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`
- **X-RestLi-Protocol-Version** (string) - Required - Must be `2.0.0`

### Response
#### Success Response (200)
- **id** (string) - User ID
- **firstName** (object) - First name data
- **lastName** (object) - Last name data
- **profilePicture** (object) - Profile picture data
- **vanityName** (string) - Vanity name (if requested)

#### Response Example
{
  "id": "abc123",
  "firstName": {
    "localized": {
      "en_US": "John"
    }
  },
  "lastName": {
    "localized": {
      "en_US": "Doe"
    }
  },
  "profilePicture": {
    "displayImage": "urn:li:digitalmediaAsset:..."
  },
  "vanityName": "johndoe"
}
```

--------------------------------

### formatConfig() method signature

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Maps a services.* config array into key names expected by league/oauth1-client servers. Used for the OAuth 1 Twitter driver. Returns array_merge with identifier, secret, and callback_uri, keeping original keys.

```php
public function formatConfig(array $config)
```

--------------------------------

### GET https://www.googleapis.com/oauth2/v3/userinfo

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Google user's profile information.

```APIDOC
## GET https://www.googleapis.com/oauth2/v3/userinfo

### Description
Retrieves the authenticated Google user's profile information.

### Method
GET

### Endpoint
https://www.googleapis.com/oauth2/v3/userinfo

### Parameters
#### Query Parameters
- **prettyPrint** (boolean) - Optional - Set to `false` to disable pretty printing

#### Headers
- **Accept** (string) - Required - Must be `application/json`
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **sub** (string) - User ID
- **name** (string) - Display name
- **given_name** (string) - Given name
- **family_name** (string) - Family name
- **picture** (string) - Profile picture URL
- **email** (string) - Email address
- **email_verified** (boolean) - Whether email is verified

#### Response Example
{
  "sub": "1234567890",
  "name": "John Doe",
  "given_name": "John",
  "family_name": "Doe",
  "picture": "https://lh3.googleusercontent.com/...",
  "email": "john@example.com",
  "email_verified": true
}
```

--------------------------------

### GET https://api.github.com/user

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated GitHub user's profile information.

```APIDOC
## GET https://api.github.com/user

### Description
Retrieves the authenticated GitHub user's profile information.

### Method
GET

### Endpoint
https://api.github.com/user

### Parameters
#### Headers
- **Accept** (string) - Required - Must be `application/vnd.github.v3+json`
- **Authorization** (string) - Required - Must be `token <token>`

### Response
#### Success Response (200)
- **id** (integer) - User ID
- **login** (string) - Username
- **name** (string) - Display name
- **email** (string) - Email address
- **avatar_url** (string) - Avatar URL

#### Response Example
{
  "id": 123456,
  "login": "octocat",
  "name": "Octocat",
  "email": "octocat@example.com",
  "avatar_url": "https://avatars.githubusercontent.com/u/123456?v=4"
}
```

--------------------------------

### Retrieve Twitter user data

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-twitter-x-twitch.md

Example of retrieving a Twitter user and accessing nickname, email, and avatar.

```php
$user = Socialite::driver('twitter')->user();

$user->getNickname();       // username
$user->getEmail();          // null unless confirmed_email present
$user->getAvatar();
```

--------------------------------

### Falling back to the real provider

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Shows that when faking with a null user, the fake provider delegates to the real provider. Drivers not faked use the real provider.

```php
Socialite::fake('github'); // user = null → FakeProvider::user() delegates to the real provider

// driver('facebook') is NOT faked → real provider
$real = Socialite::driver('facebook');
```

--------------------------------

### GET https://api.x.com/2/users/me

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated X (formerly Twitter) user's profile information.

```APIDOC
## GET https://api.x.com/2/users/me

### Description
Retrieves the authenticated X (formerly Twitter) user's profile information.

### Method
GET

### Endpoint
https://api.x.com/2/users/me

### Parameters
#### Query Parameters
- **user.fields** (string) - Required - Must be `profile_image_url,confirmed_email`

#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **data** (object) - User object
  - **id** (string) - User ID
  - **name** (string) - Display name
  - **username** (string) - Username
  - **profile_image_url** (string) - Profile image URL
  - **confirmed_email** (boolean) - Whether email is confirmed

#### Response Example
{
  "data": {
    "id": "123456789",
    "name": "John Doe",
    "username": "johndoe",
    "profile_image_url": "https://pbs.twimg.com/...",
    "confirmed_email": true
  }
}
```

--------------------------------

### FakeProvider::__construct

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Creates a new FakeProvider instance with the given driver name, resolver closure, and optional fake user or user factory.

```APIDOC
## FakeProvider::__construct

### Description
Creates a new FakeProvider instance with the given driver name, resolver closure, and optional fake user or user factory.

### Method
Constructor

### Signature
```php
public function __construct($driver, $resolver, $user = null)
```

### Parameters
- **$driver** (string) - Required - Driver name
- **$resolver** (Closure) - Required - Returns the real provider instance
- **$user** (Laravel\Socialite\Contracts\User | Closure | null) - Optional - Default: `null` - Fake user or user factory

### Returns
No return value (constructor).
```

--------------------------------

### GET https://graph.facebook.com/{version}/me

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Facebook user's profile information.

```APIDOC
## GET https://graph.facebook.com/{version}/me

### Description
Retrieves the authenticated Facebook user's profile information.

### Method
GET

### Endpoint
https://graph.facebook.com/{version}/me

### Parameters
#### Path Parameters
- **version** (string) - Required - Facebook Graph API version (e.g., v12.0)

#### Query Parameters
- **access_token** (string) - Required - User access token
- **fields** (string) - Optional - Comma-joined list of fields to return. Default: `name,email,gender,verified,link,picture.width(1920)`
- **appsecret_proof** (string) - Optional - SHA256 HMAC of the access token with the client secret, when the secret is non-empty

#### Headers
- **Accept** (string) - Required - Must be `application/json`

### Response
#### Success Response (200)
- **id** (string) - User ID
- **name** (string) - Display name
- **email** (string) - Email address
- **gender** (string) - Gender
- **verified** (boolean) - Whether the account is verified
- **link** (string) - Profile link
- **picture** (object) - Profile picture data

#### Response Example
{
  "id": "123456789",
  "name": "John Doe",
  "email": "john@example.com",
  "gender": "male",
  "verified": true,
  "link": "https://www.facebook.com/johndoe",
  "picture": {
    "data": {
      "width": 1920,
      "height": 1920,
      "url": "https://scontent.xx.fbcdn.net/..."
    }
  }
}
```

--------------------------------

### buildProvider() method signature

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Builds an OAuth 2 provider instance from a config array. Validates that client_id, client_secret, and redirect keys exist; otherwise throws DriverMissingConfigurationException. Applies scopes from the config on top of provider defaults.

```php
public function buildProvider($provider, $config)
```

--------------------------------

### Token Constructor

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-user.md

Creates a new Token instance with the provided access token, refresh token, expiration time, and approved scopes.

```APIDOC
## Token Constructor

### Description
Creates a new Token instance with the provided access token, refresh token, expiration time, and approved scopes.

### Method
Constructor

### Signature
`public function __construct(string $token, string $refreshToken, int $expiresIn, array $approvedScopes)`

### Parameters
- **$token** (string) - Required - New access token
- **$refreshToken** (string) - Required - Refresh token (may be empty string when the provider omits it)
- **$expiresIn** (int) - Required - Validity in seconds
- **$approvedScopes** (array) - Required - Scopes authorized by the user

### Usage Example
```php
$token = Socialite::driver('google')->refreshToken($user->refreshToken);

$user->setToken($token->token)
     ->setRefreshToken($token->refreshToken)
     ->setExpiresIn($token->expiresIn);
```
```

--------------------------------

### FakeProvider redirect() method

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Method signature for redirect(). Always returns a RedirectResponse to 'https://socialite.fake/'.$this->driver.'/authorize'.

```php
public function redirect()
```

--------------------------------

### formatConfig(array $config)

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-manager.md

Maps a services.* config array into the key names expected by league/oauth1-client servers.

```APIDOC
## formatConfig(array $config)

### Description
Maps a `services.*` config array into the key names expected by `league/oauth1-client` servers (used for the OAuth 1 Twitter driver).

### Method
`formatConfig`

### Parameters
- `$config` (array) - Required - `services.twitter` config array

### Returns
array — `array_merge(['identifier' => $config['client_id'], 'secret' => $config['client_secret'], 'callback_uri' => $this->formatRedirectUrl($config)], $config)`. Note the original keys are kept and only added when absent.
```

--------------------------------

### GET https://api.twitter.com/2/users/me

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Twitter user's profile information using OAuth 2.0.

```APIDOC
## GET https://api.twitter.com/2/users/me

### Description
Retrieves the authenticated Twitter user's profile information using OAuth 2.0.

### Method
GET

### Endpoint
https://api.twitter.com/2/users/me

### Parameters
#### Query Parameters
- **user.fields** (string) - Required - Must be `profile_image_url,confirmed_email`

#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **data** (object) - User object
  - **id** (string) - User ID
  - **name** (string) - Display name
  - **username** (string) - Username
  - **profile_image_url** (string) - Profile image URL
  - **confirmed_email** (boolean) - Whether email is confirmed

#### Response Example
{
  "data": {
    "id": "123456789",
    "name": "John Doe",
    "username": "johndoe",
    "profile_image_url": "https://pbs.twimg.com/...",
    "confirmed_email": true
  }
}
```

--------------------------------

### GET https://slack.com/api/openid.connect.userInfo

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated Slack user's profile information using OpenID Connect.

```APIDOC
## GET https://slack.com/api/openid.connect.userInfo

### Description
Retrieves the authenticated Slack user's profile information using OpenID Connect.

### Method
GET

### Endpoint
https://slack.com/api/openid.connect.userInfo

### Parameters
#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`

### Response
#### Success Response (200)
- **sub** (string) - User ID
- **name** (string) - Display name
- **email** (string) - Email address
- **email_verified** (boolean) - Whether email is verified

#### Response Example
{
  "sub": "U123456",
  "name": "John Doe",
  "email": "john@example.com",
  "email_verified": true
}
```

--------------------------------

### PHPDoc for Socialite facade methods

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-facade.md

Documents the statically accessible method surface forwarded to SocialiteManager, including driver, buildProvider, extend, getScopes, scopes, setScopes, and redirectUrl.

```php
/**
 * @method static \Laravel\Socialite\Contracts\Provider driver(string $driver = null)
 * @method static \Laravel\Socialite\Two\AbstractProvider buildProvider(string $provider, array $config)
 * @method static \Laravel\Socialite\SocialiteManager extend(string $driver, \Closure $callback)
 * @method array getScopes()
 * @method \Laravel\Socialite\Contracts\Provider scopes(array|string $scopes)
 * @method \Laravel\Socialite\Contracts\Provider setScopes(array|string $scopes)
 * @method \Laravel\Socialite\Contracts\Provider redirectUrl(string $url)
 *
 * @see \Laravel\Socialite\SocialiteManager
 */
```

--------------------------------

### GET https://api.linkedin.com/v2/userinfo

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Retrieves the authenticated LinkedIn user's profile information using OpenID Connect.

```APIDOC
## GET https://api.linkedin.com/v2/userinfo

### Description
Retrieves the authenticated LinkedIn user's profile information using OpenID Connect.

### Method
GET

### Endpoint
https://api.linkedin.com/v2/userinfo

### Parameters
#### Query Parameters
- **projection** (string) - Required - Must be `(sub,email,email_verified,name,given_name,family_name,picture)`

#### Headers
- **Authorization** (string) - Required - Must be `Bearer <token>`
- **X-RestLi-Protocol-Version** (string) - Required - Must be `2.0.0`

### Response
#### Success Response (200)
- **sub** (string) - User ID
- **email** (string) - Email address
- **email_verified** (boolean) - Whether email is verified
- **name** (string) - Display name
- **given_name** (string) - Given name
- **family_name** (string) - Family name
- **picture** (string) - Profile picture URL

#### Response Example
{
  "sub": "abc123",
  "email": "john@example.com",
  "email_verified": true,
  "name": "John Doe",
  "given_name": "John",
  "family_name": "Doe",
  "picture": "https://media.licdn.com/..."
}
```

--------------------------------

### Token constructor signature

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-user.md

Defines the constructor with parameters for token, refreshToken, expiresIn, and approvedScopes. All parameters are required.

```php
public function __construct(string $token, string $refreshToken, int $expiresIn, array $approvedScopes)
```

--------------------------------

### SocialiteServiceProvider register and provides methods

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/socialite-facade.md

Registers the SocialiteManager as a singleton bound to the Factory contract and returns the Factory class in provides() for deferred provider loading.

```php
public function register()
{
    $this->app->singleton(Factory::class, function ($app) {
        return new SocialiteManager($app);
    });
}

public function provides()
{
    return [Factory::class];
}
```

--------------------------------

### GET https://www.googleapis.com/oauth2/v3/certs

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Returns the JSON Web Key Set (JWKS) used when the token looks like a JWT id-token.

```APIDOC
## GET https://www.googleapis.com/oauth2/v3/certs

### Description
Returns the JSON Web Key Set (JWKS) used when the token looks like a JWT id-token.

### Method
GET

### Endpoint
https://www.googleapis.com/oauth2/v3/certs

### Response
#### Success Response (200)
- **keys** (array) - Array of JWK objects

#### Response Example
{
  "keys": [
    {
      "kty": "RSA",
      "use": "sig",
      "kid": "abc123",
      "n": "...",
      "e": "AQAB"
    }
  ]
}
```

--------------------------------

### GET https://limited.facebook.com/.well-known/oauth/openid/jwks/

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/endpoints.md

Returns the JSON Web Key Set (JWKS) used to verify Limited Login OIDC id-tokens.

```APIDOC
## GET https://limited.facebook.com/.well-known/oauth/openid/jwks/

### Description
Returns the JSON Web Key Set (JWKS) used to verify Limited Login OIDC id-tokens.

### Method
GET

### Endpoint
https://limited.facebook.com/.well-known/oauth/openid/jwks/

### Response
#### Success Response (200)
- **keys** (array) - Array of JWK objects

#### Response Example
{
  "keys": [
    {
      "kty": "RSA",
      "use": "sig",
      "kid": "abc123",
      "n": "...",
      "e": "AQAB"
    }
  ]
}
```

--------------------------------

### FakeProvider constructor

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Constructor signature for FakeProvider. Accepts the driver name, a resolver closure that returns the real provider, and an optional fake user or user factory.

```php
public function __construct($driver, $resolver, $user = null)
```

--------------------------------

### AbstractProvider userFromTokenAndSecret method

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/one-providers.md

Builds a user from stored OAuth 1 credentials without a session round-trip. Wraps the token and secret in TokenCredentials, calls getUserDetails(), and maps the result into a One\User.

```php
public function userFromTokenAndSecret($token, $secret)
```

--------------------------------

### setRaw() method and usage

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/abstract-user.md

Sets the raw user array and returns $this for fluency. The example shows creating a Two\User instance and setting the raw payload.

```php
public function setRaw(array $user)
```

```php
$user = (new \Laravel\Socialite\Two\User)->setRaw($providerPayload);
```

--------------------------------

### Forwarded calls (decorator behavior)

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/testing.md

Demonstrates that methods not defined on FakeProvider are forwarded to the real provider. stateless() is forwarded, but user() still returns the fake user.

```php
Socialite::fake('twitter', User::fake());

// stateless() is not defined on FakeProvider -> forwarded to the real provider
$provider = Socialite::driver('twitter')->stateless();

// user() still returns the fake user
$user = $provider->user();
```

--------------------------------

### userFromToken() method signature

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/two-abstract-provider.md

Builds a user instance from a known access token without code exchange or state validation.

```php
public function userFromToken($token)
```

--------------------------------

### BitbucketProvider class declaration

Source: https://github.com/laravel/socialite/blob/5.x/_autodocs/api-reference/oauth2-providers-github-gitlab-bitbucket.md

Declares the BitbucketProvider class extending AbstractProvider and implementing ProviderInterface.

```php
class BitbucketProvider extends AbstractProvider implements ProviderInterface
```
Tokens:
Raw