LinkedIn Provider for the OAuth 2.0 Client
PHP
Latest commit a554636 Nov 9, 2016 @stevenmaguire stevenmaguire committed on GitHub Merge pull request #5 from karriereat/bugfix/check-if-field-exists
Check if index is set in response during method call
Permalink
Failed to load latest commit information.
src/Provider fixed code-style error with newline between last method and closing b… Nov 9, 2016
test/src/Provider Check if field exists in response array when using the methods to get… Nov 9, 2016
.gitignore test coverage report generation and refactoring userDetails Apr 14, 2015
.scrutinizer.yml adding scrutinizer config Apr 14, 2015
.travis.yml removing allowed failures from test suite Jul 21, 2015
CHANGELOG.md
CONTRIBUTING.md adding contribution notes Mar 22, 2015
LICENSE
README.md
composer.json update dependency on league/oauth2-client@1.0 Aug 20, 2015
phpunit.xml test coverage report generation and refactoring userDetails Apr 14, 2015

README.md

LinkedIn Provider for OAuth 2.0 Client

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

This package provides LinkedIn OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require league/oauth2-linkedin

Usage

Usage is the same as The League's OAuth client, using \League\OAuth2\Client\Provider\LinkedIn as the provider.

Authorization Code Flow

$provider = new League\OAuth2\Client\Provider\LinkedIn([
    'clientId'          => '{linkedin-client-id}',
    'clientSecret'      => '{linkedin-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
]);

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a users profile data
    try {

        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getFirstname());

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Managing Scopes

When creating your LinkedIn authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['r_basicprofile','r_emailaddress'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available.

  • r_basicprofile
  • r_emailaddress
  • rw_company_admin
  • w_share

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.