Installation & Setup#


You can add the package to your project using Composer, or as a requirement in your composer.json file directly:

composer require verbb/auth
"require": {
    "php": "^8.0.2",
    "craftcms/cms": "^4.0.0",
    "verbb/auth": "^1.0.0"


There's a few things you'll need to do to get the Auth module working for your plugin.


In your plugin's init() function, you'll need to initialize the Auth module.

public function init(): void

    // Initialize the Auth module

    // ...

With that done, you'll be able to access the methods in the Auth module.


Because the Auth plugin stores OAuth tokens in its own database table that's plugin-agnostic, you'll need to ensure that Auth's migration is run. In your plugin's migrations\Install.php file, add the following:

class Install extends \craft\db\Migration
    public function safeUp(): bool
        // Ensure that the Auth module kicks off setting up tables

        // Create any tables that your plugin requires

        // ...

This will ensure that the Auth database tables are created (if they don't already exist from another plugin requiring it), ready for you to add tokens to.

That completes the setup side of things!