adam-paterson / oauth2-slack
Slack OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 465 385
Dependents: 3
Suggesters: 0
Security: 0
Stars: 21
Watchers: 3
Forks: 22
Open Issues: 7
Requires
- php: >=5.6.0
- league/oauth2-client: 1.*|2.*
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: 5.6
- squizlabs/php_codesniffer: ~2.0
This package is not auto-updated.
Last update: 2024-10-26 19:21:25 UTC
README
This package provides Slack OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
$ composer require adam-paterson/oauth2-slack
Usage
Usage is the same as The League's OAuth client, using \AdamPaterson\OAuth2\Client\Provider\Slack
as the provider.
Authorization Code Flow
<?php session_start(); $provider = new \AdamPaterson\OAuth2\Client\Provider\Slack([ 'clientId' => '{slack-client-id}', 'clientSecret' => '{slack-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 $team = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $team->getName()); } 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(); }
Scopes
OAuth scopes, indicating which parts of the Slack user's account you'd like your app to be able to access. The complete list of scopes can be found here.
$provider = new \AdamPaterson\OAuth2\Client\Provider\Slack([ 'clientId' => '{slack-client-id}', 'clientSecret' => '{slack-client-secret}', 'redirectUri' => 'https://example.com/callback-url', ]); $authUrl = $provider->$provider->getAuthorizationUrl([ 'scope' => 'user:read user:write file:write' ]);
Bot Access Tokens
If your Slack app includes a bot user, upon approval the JSON response will contain an additional node containing an access token to be specifically used for your bot user, within the context of the approving workspace.
Note: You must pass the bot
scope for this additional node to be present
$authUrl = $provider->$provider->getAuthorizationUrl([ 'scope' => 'bot' ]); $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); $values = $token->getValues(); // bot user id $botUserId = $values['bot']['bot_user_id']; $botAccessToken = $values['bot']['bot_access_token'];
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.