iamprashant/slack-oauth2

Slack OAuth 2.0 Client Provider for The PHP League OAuth2-Client

v1.2 2023-01-08 19:35 UTC

Requires

• php: >=7.4.0
• league/oauth2-client: 2.6.1

Requires (Dev)

• mockery/mockery: 1.5.1
• phpunit/phpunit: 9.5.27
• squizlabs/php_codesniffer: 3.7.1

MIT

• Prashant Srivastav

• authorization
• Authentication
• oauth
• oauth2
• SSO
• identity
• idp
• single sign on
• slack
• slack api

README

This package is based on League's OAuth 2.0 Client with Slack v2 api.

Installation

$ composer require iamprashant/oauth2-slack

Usage

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

Authorize Url generation

$provider = new \IamPrashant\OAuth2\Client\Provider\Slack([
    'clientId'          => '{client-id}',
    'clientSecret'      => '{client-secret}',
    'redirectUri'       => '{callback-url}',
]);
 
// to get authorization url
$authUrl = $provider->getAuthorizationUrl();


// if you need to request the user_scope also with global scope
$authUrl = $provider->getAuthorizationUrl(["user_scope"=>"users.profile:read,users:read.email,users:read,im:history"]);

// can request with global scope

$authUrl = $provider->getAuthorizationUrl(['scope' => 'user:read user:write file:write', "user_scope"=>"users.profile:read,users:read.email,users:read,im:history"]);

Authorization Flow

$provider = new \IamPrashant\OAuth2\Client\Provider\Slack([
    'clientId'          => '{client-id}',
    'clientSecret'      => '{client-secret}',
    'redirectUri'       => '{callback-url}',
]);

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

    // token requested
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);
    //  Token object will contains channels (if webhoooks enable) and team 
    try {
        // to get user details with complete informaiton
        $user = $provider->getResourceOwner($token);
        // Use these details to create a new profile
        var_dump($user);
    } catch (Exception $e) {
        // Failed to get user details
        exit('something got unexpected');
    }
 
    var_dump($token->getToken());
}

Contributing

Feel free to create pull request, Thanks for contributing.