Laravel Socialite 的 Slack OAuth2 提供者

5.1.0 2024-08-29 02:33 UTC

README

与官方提供者的比较

Socialite 现在有一个官方的 Slack 提供者,但社交ite 提供者和官方提供者之间有一些重要的区别。特别是,这个提供者允许您请求用户和机器人范围,因此可以获取用户令牌和机器人令牌。请参阅下面的相关部分。

https://laravel.net.cn/docs/11.x/socialite#installation

安装与基本用法

请参阅基本安装指南,然后按照以下特定提供者说明操作。

config/services.php 中添加配置

'slack' => [    
  'client_id' => env('SLACK_CLIENT_ID'),  
  'client_secret' => env('SLACK_CLIENT_SECRET'),  
  'redirect' => env('SLACK_REDIRECT_URI') 
],

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中,默认的 EventServiceProvider 提供者已被删除。相反,您需要在您的 AppServiceProviderboot 方法中使用 Event 门面的 listen 方法添加监听器。

  • 注意:除非您用自己的提供者覆盖它们,否则您不需要为内置的 socialite 提供者添加任何内容。
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('slack', \SocialiteProviders\Slack\Provider::class);
});
Laravel 10 或以下配置包的监听器以监听 `SocialiteWasCalled` 事件。

将事件添加到 app/Providers/EventServiceProvider 中的 listen[] 数组中。有关详细说明,请参阅基本安装指南

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Slack\SlackExtendSocialite::class.'@handle',
    ],
];

用法

现在您应该能够像平时使用 Socialite 一样使用提供者(假设您已安装了门面)

return Socialite::driver('slack')->redirect();

此包允许您请求机器人和用户范围。用户范围使用标准 ->scopes() 方法设置,而机器人范围则通过 ->botScopes() 方法设置。

return Socialite::driver('slack')->scopes(['identity.basic', 'identity.email', 'identity.team'])->botScopes(['chat:write','commands'])->redirect();

返回的用户字段

  • id
  • name
  • email
  • avatar
  • organization_id