tobymaxham/phoenix-socialite

PhoenixII OAuth2 Provider for Laravel Socialite

Maintainers

Details

github.com/TobyMaxham/phoenix-socialite

Homepage

Source

Issues

Fund package maintenance!
TobyMaxham

Installs: 5

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

1.0.0 2021-12-18 23:40 UTC

Requires

Requires (Dev)

MIT 5dcf1145214d0ff739d81b7dd51fcc5f22a74e50

oauthproviderlaravelsocialitetobymaxhamphoenix-oauthphoenix-socialite

This package is auto-updated.

Last update: 2024-04-19 05:01:02 UTC

README

Latest Version on Packagist Tests Total Downloads

This package can be used to add a Laravel Socialite driver using the PhoenixII OAuth2-API.

If you do not have a laravel installation, please check out my other package which can be used without a framework: https://github.com/TobyMaxham/phoenixii-oauth2

Installation

composer require tobymaxham/phoenix-socialite

Configuration & Basic Usage

As an organisation using PhoenixII you can use this package for any third party software to enable OAuth2. This will give your users an easy and comfortable way to use the third party application. A users wich is already a registered user on your PhoenixII instance, they do not need to register a second account on your platform.

For more information read the documentation: https://tricept.atlassian.net/wiki/spaces/PIIWIKI/pages/976912387/OAuth+2+-+Schnittstelle

Add configuration to config/services.php

'phoenix-auth' => [
   'instance' => 'https://{instance}.it4sport.de',
   'client_id' => env('PHOENIX_CLIENT_ID'),  
   'client_secret' => env('PHOENIX_CLIENT_SECRET'),  
   'redirect' => env('PHOENIX_REDIRECT_URI'),
   'token' => env('PHOENIX_BEARER_TOKEN'),
],

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('phoenix-auth')->redirect();

Returned User fields

  • id
  • firstname
  • lastname
  • email
  • birthday
  • organisation
  • licenses
  • functions
  • addresses

Important note

This package is not developed or maintained by PhoenixII (it4sport). This package was created using the public OAuth-Documentation.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.