intercom / oauth2-intercom
Intercom OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 156 668
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 145
Forks: 7
Open Issues: 2
Requires
- php: ^5.6|^7.0
- league/oauth2-client: ~2.3
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
README
This package provides Intercom OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require intercom/oauth2-intercom
Usage
Usage is the same as The League's OAuth client, using \Intercom\OAuth2\Client\Provider\Intercom
as the provider.
Authorization Code Flow
$provider = new Intercom\OAuth2\Client\Provider\Intercom([ 'clientId' => '{intercom-client-id}', 'clientSecret' => '{intercom-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 { // Get access token using the authorization code grant $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); // Optional: Now you have 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->getName()); } catch (Exception $e) { exit('Failed to get user details'); } echo $token; }
By default Intercom provider rejects users with unverified email addresses. User info will not be populated in that case. To disable this check add verifyEmail set to false to your config:
$provider = new Intercom\OAuth2\Client\Provider\Intercom([ 'clientId' => '{intercom-client-id}', 'clientSecret' => '{intercom-client-secret}', 'redirectUri' => 'https://example.com/callback-url', 'verifyEmail' => false ]);
Refreshing a Token
Intercom's OAuth implementation does not use refresh tokens. Access tokens are valid until a user revokes access manually, or until an app deauthorizes itself.
Testing
$ ./vendor/bin/phpunit
License
The Apache 2 License. Please see License File for more information.