Zendesk Provider for the OAuth 2.0 Client
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Provider
tests
.gitignore
.scrutinizer.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
composer.json
phpunit.xml.dist

README.md

Zendesk Provider for OAuth 2.0 Client

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

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

Installation

To install, use composer:

composer require stevenmaguire/oauth2-zendesk

Usage

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

Authorization Code Flow

$provider = new Stevenmaguire\OAuth2\Client\Provider\Zendesk([
    'clientId'          => '{zendesk-client-id}',
    'clientSecret'      => '{zendesk-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'subdomain'         => 'your-zendesk-subdomain',
]);

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

Update and read subdomain after configuration

$currentSubdomain = $provider->getSubdomain();
$newSubdomain = $currentSubdomain . '-v2';
$provider->setSubdomain($newSubdomain);

The provider will not complete configuration if a subdomain is not provided and updating the subdomain will silently fail if the value provided does not return truthy from empty().

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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