PHPackages craftcms/oauth2-craftid - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. craftcms/oauth2-craftid AbandonedArchivedLibrary[Authentication & Authorization](/categories/authentication) craftcms/oauth2-craftid ======================= Craft OAuth 2.0 Client Provider for The PHP League OAuth2-Client 1.0.0.1(8y ago)152.6M↓32.5%1[2 PRs](https://github.com/craftcms/oauth2-craftid/pulls)MITPHP Since Nov 22Pushed 3y ago1 watchersCompare [ Source](https://github.com/craftcms/oauth2-craftid)[ Packagist](https://packagist.org/packages/craftcms/oauth2-craftid)[ RSS](/packages/craftcms-oauth2-craftid/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (4)Versions (6)Used By (0) Craft ID Provider for OAuth 2.0 Client ====================================== [](#craft-id-provider-for-oauth-20-client) This package provides Craft ID OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client). This package is compliant with [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md), [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and [PSR-4](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md). If you notice compliance oversights, please send a patch via pull request. Requirements ------------ [](#requirements) The following versions of PHP are supported. - PHP 5.6 - PHP 7.0 - PHP 7.1 - HHVM Installation ------------ [](#installation) To install, use composer: ``` composer require craftcms/oauth2-craftid ``` Usage ----- [](#usage) ### Authorization Code Flow [](#authorization-code-flow) ``` $provider = new \craftcms\oauth2\client\provider\CraftId([ 'clientId' => '{craft-app-id}', 'clientSecret' => '{craft-app-secret}', 'redirectUri' => 'https://example.com/callback-url', ]); if (!empty($_GET['error'])) { // Got an error, probably user denied access exit('Got error: ' . htmlspecialchars($_GET['error'], ENT_QUOTES, 'UTF-8')); } elseif (empty($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['oauth2state'] = $provider->getState(); header('Location: ' . $authUrl); exit; } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) { // State is invalid, possible CSRF attack in progress 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 users profile data try { // We got an access token, let's now get the owner details $ownerDetails = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $ownerDetails->getName()); } catch (Exception $e) { // Failed to get user details exit('Something went wrong: ' . $e->getMessage()); } // Use this to interact with an API on the users behalf echo $token->getToken(); // Use this to get a new access token if the old one expires echo $token->getRefreshToken(); // Number of seconds until the access token will expire, and need refreshing echo $token->getExpires(); } ``` Scopes ------ [](#scopes) If needed, you can include an array of scopes when getting the authorization url. Example: ``` $authorizationUrl = $provider->getAuthorizationUrl([ 'scope' => [ 'purchasePlugins', 'existingPlugins', 'transferPluginLicense', 'deassociatePluginLicense', ] ]); header('Location: ' . $authorizationUrl); exit; ``` Testing ------- [](#testing) ``` $ ./vendor/bin/phpunit ``` Credits ------- [](#credits) - [Pixel & Tonic](https://pixelandtonic.com/) - [All Contributors](https://github.com/craftcms/oauth2-craftid/contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](https://github.com/craftcms/oauth2-craftid/blob/master/LICENSE.md) for more information. ### Health Score 41 — FairBetter than 89% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity46 Moderate usage in the ecosystem Community13 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 61.9% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 2 Last Release 3098d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3ccdf8b493035de2343c55bd889513e3af5c04d5823482a2b186ad16adb1c3e3?d=identicon)[brandonkelly](/maintainers/brandonkelly) --- Top Contributors [![benjamindavid](https://avatars.githubusercontent.com/u/2911900?v=4)](https://github.com/benjamindavid "benjamindavid (26 commits)")[![angrybrad](https://avatars.githubusercontent.com/u/61869?v=4)](https://github.com/angrybrad "angrybrad (7 commits)")[![lukeholder](https://avatars.githubusercontent.com/u/133571?v=4)](https://github.com/lukeholder "lukeholder (5 commits)")[![brandonkelly](https://avatars.githubusercontent.com/u/47792?v=4)](https://github.com/brandonkelly "brandonkelly (4 commits)") --- Tags oauth2clientAuthenticationoauthoauth2authorizationcmscraftcmscraftid ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/craftcms-oauth2-craftid/health.svg) ``` [![Health](https://phpackages.com/badges/craftcms-oauth2-craftid/health.svg)](https://phpackages.com/packages/craftcms-oauth2-craftid) ``` ### Alternatives [league/oauth2-google Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client 41721.2M118](/packages/league-oauth2-google)[cakedc/oauth2-cognito Cognito OAuth 2.0 Client Provider for The PHP League OAuth2-Client 18597.7k](/packages/cakedc-oauth2-cognito) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)