stevenmaguire / oauth2-nest
Nest OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Requires
- league/oauth2-client: ^2.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-10-14 10:56:01 UTC
README
This package provides Nest OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require stevenmaguire/oauth2-nest
Usage
Usage is the same as The League's OAuth client, using \Stevenmaguire\OAuth2\Client\Provider\Nest
as the provider.
Authorization Code Flow
$provider = new Stevenmaguire\OAuth2\Client\Provider\Nest([ 'clientId' => '{nest-client-id}', 'clientSecret' => '{nest-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]);
For further usage of this package please refer to the core package documentation on "Authorization Code Grant".
Resource owner information
Nest does not support access to any personal information of the authorizing resource owner. As such, this package does not support the getResourceOwner
method documented in the core package.
This package will throw a Stevenmaguire\OAuth2\Client\Provider\Exception\ResourceOwnerException
exception if you attempt to use this method.
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.