Basic Usage

If you successfully configured the OAuth2 server as detailed in the introduction section, you can request an access token using the OAuth2 server route you defined (e.g. /oauth).

You can require an access token using one of the following scenarios:

• client credentials;
• password;
• authorization code;
• implicit;
• refresh token.

Authenticate a Middleware

This library uses the authentication abstraction of the Mezzio\Authentication\AuthenticationMiddleware class provided by mezzio-authentication.

In order to use OAuth2, we need to configure the service Mezzio\Authentication\AuthenticationInterface to resolve to Mezzio\Authentication\OAuth2\OAuth2Adapter. This can be achieved using the following configuration:

use Mezzio\Authentication;

return [
    'dependencies' => [
        'aliases' => [
            Authentication\AuthenticationInterface::class => Authentication\OAuth2\OAuth2Adapter::class,
        ],
    ],
];

The previous configuration will instruct mezzio-authentication to use the OAuth2 adapter provided in this package. (Unlike other adapters, this adapter does not require a Mezzio\Authentication\UserRepositoryInterface; the OAuth2 database with user and client credentials is managed by the component itself.)

When the service alias is configured, you can immediately begin authenticating your application/API by adding the AuthenticationMiddleware to either your application or route-specific middleware pipeline. For instance, using an Mezzio application, you could add it to a specific route, as follows:

$app->post('/api/users', [
    Mezzio\Authentication\AuthenticationMiddleware::class,
    App\Action\AddUserAction::class,
], 'api.add.user');

Providing an Authorization Server

See the chapter Authorization server for details on how to implement this.