Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adam-paterson/oauth2-slack
Slack OAuth 2.0 Client Provider for The PHP League OAuth2-Client
https://github.com/adam-paterson/oauth2-slack
oauth2 slack
Last synced: 22 days ago
JSON representation
Slack OAuth 2.0 Client Provider for The PHP League OAuth2-Client
- Host: GitHub
- URL: https://github.com/adam-paterson/oauth2-slack
- Owner: adam-paterson
- License: mit
- Created: 2015-08-27T14:48:43.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2020-11-23T15:30:04.000Z (almost 4 years ago)
- Last Synced: 2024-09-16T14:49:22.485Z (about 2 months ago)
- Topics: oauth2, slack
- Language: PHP
- Homepage: http://oauth2-client.thephpleague.com/
- Size: 36.1 KB
- Stars: 21
- Watchers: 3
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Slack Provider for OAuth 2.0 Client
[](https://github.com/adam-paterson/oauth2-slack/releases)
[](LICENSE.md)
[](https://travis-ci.org/adam-paterson/oauth2-slack)
[](http://hhvm.h4cc.de/package/adam-paterson/oauth2-slack)
[](https://scrutinizer-ci.com/g/adam-paterson/oauth2-slack/code-structure)
[](https://scrutinizer-ci.com/g/adam-paterson/oauth2-slack)
[](https://www.versioneye.com/php/adam-paterson:oauth2-slack/1.1.2)
[](https://packagist.org/packages/adam-paterson/oauth2-slack)
This package provides Slack OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).
## Installation
To install, use composer:
```bash
$ 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
'{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](https://api.slack.com/docs/oauth-scopes).
```php
$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**
```php
$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
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/adam-paterson/oauth2-slack/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Adam Paterson](https://github.com/adam-paterson)
- [All Contributors](https://github.com/adam-paterson/oauth2-slack/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/adam-paterson/oauth2-slack/blob/master/LICENSE) for more information.