README

This package provides Deputy OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Usage

Usage is similar to The League's OAuth client, using \Cartertech\OAuth2\Client\Provider\Deputy as the provider.

Authorization Code Flow

$provider = new Cartertech\OAuth2\Client\Provider\Deputy([
    'clientId'                => <your_client_id>,    // The client ID assigned to you by the provider
    'clientSecret'            => <your_client_secret>,    // The client password assigned to you by the provider
    'redirectUri'             => 'https://example.com/callback.php,
    'urlAuthorize'            => 'https://once.deputy.com/my/oauth/login',
    'urlAccessToken'          => 'https://once.deputy.com/my/oauth/access_token'
]);

For further usage of this package please refer to the core package documentation on "Authorization Code Grant".

To configure Deputy to allow OAuth authentication please refer to Deputy's documentation.

Refreshing a Token

$existingAccessToken = getAccessTokenFromYourDataStore();

if ($existingAccessToken->hasExpired()) {
    $newAccessToken = $provider->getAccessToken('refresh_token', [
        'refresh_token' => $existingAccessToken->getRefreshToken()
    ]);

    // Purge old access token and store new access token to your data store.
}

Storing the endpoint URL for the Provider's use

$provider->setDomain($accessToken->getEndpointUrl());

For further usage of this package please refer to the core package documentation on "Refreshing a Token".

Credits

License

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

cartertech / oauth2-deputy

Maintainers

Details