Skip to content

Latest commit

 

History

History
181 lines (122 loc) · 6.58 KB

README.md

File metadata and controls

181 lines (122 loc) · 6.58 KB
Raw

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.

Before You Begin

The LinkedIn API has been largely closed off and is only available to approved LinkedIn developers. You can request authorization here - https://business.linkedin.com/marketing-solutions/marketing-partners/become-a-partner/marketing-developer-program

You may be able to successfully obtain Access Tokens using this package and still not be authorized to access some resources available in the API.

If you encounter the following, or something similar, this policy is being enforced.

{
    "serviceErrorCode": 100,
    "message": "Not enough permissions to access: GET /me",
    "status": 403
}

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

Retrieving LinkedIn member information

When fetching resource owner details, the provider allows for an explicit list of fields to be returned, so long as they are allowed by the scopes used to retrieve the access token.

A default set of fields is provided. Overriding these defaults and defining a new set of fields is easy using the withFields method, which is a fluent method that returns the updated provider.

You can find a complete list of fields on LinkedIn's Developer Documentation.

$fields = [
    'id', 'first-name', 'last-name', 'maiden-name', 'formatted-name',
    'phonetic-first-name', 'phonetic-last-name', 'formatted-phonetic-name',
    'headline', 'location', 'industry', 'current-share', 'num-connections',
    'num-connections-capped', 'summary', 'specialties', 'positions',
    'picture-url', 'picture-urls', 'site-standard-profile-request',
    'api-standard-profile-request', 'public-profile-url'
];

$provider = $provider->withFields($fields);
$member = $provider->getResourceOwner($token);

// or in one line...

$member = $provider->withFields($fields)->getResourceOwner($token);

The getResourceOwner will return an instance of League\OAuth2\Client\Provider\LinkedInResourceOwner which has some helpful getter methods to access basic member details.

For more customization and control, the LinkedInResourceOwner object also offers a getAttribute method which accepts a string to access specific attributes that may not have a getter method explicitly defined.

$location = $member->getLocation();

// or

$location = $member->getAttribute('location.name');

Resource Owner Endpoint Versions

The LinkedIn API has begun supporting a second version. You can configure the provider to specify which version of the resource owner endpoint you'd like to use.

Version 1 is configured by default.

// https://api.linkedin.com/v1/people/~
$member = $provider->withResourceOwnerVersion(1)->getResourceOwner($token);

// https://api.linkedin.com/v2/me
$member = $provider->withResourceOwnerVersion(2)->getResourceOwner($token);

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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