README

This package provides Zenith OAuth 2.0 support for The PHP League's OAuth 2.0 Client

Installation

Install with composer:

composer require magician/oauth2-zenith

Usage

$provider = new \Magician\OAuth2\Client\Provider\ZenithProvider([
    'clientId'     => '{client-id}',
    'clientSecret' => '{client-secret}',
    'redirectUri'  => 'https://example.com/callback-url',
    'zenithUri'    => 'https://zenith.example.com',
]);

if (!isset($_GET['code'])) {
    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: ' . $authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {
    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a user's profile data
    try {
        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // The $user object is an instance of \CHEZ14\OAuth2\Client\Provider\AuthentikUser
        // You can access user data using the getter methods:
        echo 'Hello ' . $user->getName() . "!\n"; // "Hello Someone Somewhere!"
        echo 'Your user ID is ' . $user->getId() . ".\n"; // "Your user ID is 64character-unique-user-id-1234567890abcdef."
        echo 'Your email is ' . $user->getEmail() . ".\n"; // "Your email is someone@somewhere.com."

        $userData = $user->toArray();
        var_dump($userData);

        // Use this to interact with an API on the users behalf
        echo $token->getToken();

    } catch (\Exception $e) {
        // Failed to get user details
        exit('Something went wrong: ' . $e->getMessage());
    }
}

Managing Scopes

You can chose between three different scopes at this time:

$options = [
    'scope' => ['openid', 'profile', 'email'],
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

License

Licensed under the Teaware License. See LICENSE for more information.