Skip to content

Instantly share code, notes, and snippets.

@tjamps
Last active Aug 10, 2022
Embed
What would you like to do?
Basic RESTful API with Symfony 2 + FOSRestBundle (JSON format only) + FOSUserBundle + FOSOauthServerBundle

Basic RESTful API with Symfony 2 + FOSRestBundle (JSON format only) + FOSUserBundle + FOSOauthServerBundle

The API we are creating in this gist will follow these rules :

  • The API only returns JSON responses
  • All API routes require authentication
  • Authentication is handled via OAuth2 with password Grant Type only (no need for Authorization pages and such).
  • API versioning is managed via a subdomain (e.g. v1.api.example.com)

The API will be written in PHP with the Symfony 2 framework. The following SF2 bundles are used :

Install SF2 and the bundles

The first step is to download Symfony and the related bundles. I willl use the Symfony Installer and Composer (installed globally)

symfony new api
cd api
composer require friendsofsymfony/rest-bundle
composer require jms/serializer-bundle
composer require nelmio/api-doc-bundle
composer require friendsofsymfony/user-bundle
composer require friendsofsymfony/oauth-server-bundle

Add the following lines to app/AppKernel.php to enable the downloaded bundles :

// app/AppKernel.php
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new FOS\RestBundle\FOSRestBundle(),
            new FOS\UserBundle\FOSUserBundle(),
            new FOS\OAuthServerBundle\FOSOAuthServerBundle(),
            new JMS\SerializerBundle\JMSSerializerBundle(),
            new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
        );

        // ...
    }
}

## Configure bundles

A bit of configuration is required now.

NOTE : the classes under the Acme\ApiBundle\Entity namespace will be created in just a minute.

Configuration

Add the following to app/config/config.yml :

# app/config/config.yml
nelmio_api_doc: ~

fos_rest:
    routing_loader:
        default_format: json                            # All responses should be JSON formated
        include_format: false                           # We do not include format in request, so that all responses
                                                        # will eventually be JSON formated

fos_user:
    db_driver: orm
    firewall_name: api                                  # Seems to be used when registering user/reseting password,
                                                        # but since there is no "login", as so it seems to be useless in
                                                        # our particular context, but still required by "FOSUserBundle"
    user_class: Acme\ApiBundle\Entity\User

fos_oauth_server:
    db_driver:           orm
    client_class:        Acme\ApiBundle\Entity\Client
    access_token_class:  Acme\ApiBundle\Entity\AccessToken
    refresh_token_class: Acme\ApiBundle\Entity\RefreshToken
    auth_code_class:     Acme\ApiBundle\Entity\AuthCode
    service:
        user_provider: fos_user.user_manager             # This property will be used when valid credentials are given to load the user upon access token creation

### Security

Add the following to app/config/security.yml :

# app/config/security.yml

security:
    encoders:
        FOS\UserBundle\Model\UserInterface: sha512

    providers:
        fos_userbundle:
            id: fos_user.user_provider.username        # fos_user.user_provider.username_email does not seem to work (OAuth-spec related ("username + password") ?)
    firewalls:
        oauth_token:                                   # Everyone can access the access token URL.
            pattern: ^/oauth/v2/token
            security: false
        api:
            pattern: ^/                                # All URLs are protected
            fos_oauth: true                            # OAuth2 protected resource
            stateless: true                            # Do no set session cookies
            anonymous: false                           # Anonymous access is not allowed

You can add more access_control properties here.

Routing

Add the following to app/config/routing.yml :

# app/config/routing.yml
NelmioApiDocBundle:
    resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
    prefix:   /api/doc

fos_oauth_server_token:
    resource: "@FOSOAuthServerBundle/Resources/config/routing/token.xml"

API Bundle

NOTE : this step is not strictly required : you are actually free to organize your code as you want. I am using only one bundle here for the sake of simplicity, but feel free to follow what you heart says ;)

Next we need to create entities to handle user, access tokens, etc... We are going to create a bundle for that purpose :

php app/console generate:bundle --namespace=Acme/ApiBundle

Next step is creating the entities.

User entity

This entity is required by FOSUserBundle and will also be used by FOSOAuthServerBundle. As stated in the documentation, you are free to do (almost) whatever you want to with this class. The one used in this gist is just a simple copy/paste of the class available in the documentation, but with the following changes :

  • it extends FOS\UserBundle\Entity\User and not FOS\UserBundle\Model\User (further doctrine schema update did not work for me with the later)
  • the name of the table is customized : @ORM\Table("users")
<?php
// src/Acme/ApiBundle/Entity/User.php

namespace Acme\ApiBundle\Entity;

use FOS\UserBundle\Entity\User as BaseUser;
use Doctrine\ORM\Mapping as ORM;

/**
 * User
 *
 * @ORM\Table("users")
 * @ORM\Entity
 */
class User extends BaseUser
{
    /**
     * @var integer
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;


    /**
     * Get id
     *
     * @return integer
     */
    public function getId()
    {
        return $this->id;
    }
}

## Other entities

These entities are required by the FOSOAuthServerBundle. They are simple copy/paste from the documentation with namespace adjustements. Notice the table names have been adjusted too. Also, make sure the targetEntity parameter of the @ORM\ManyToOne annotation points to the user entity you created in the previous step :

<?php
// src/Acme/ApiBundle/Entity/Client.php

namespace Acme\ApiBundle\Entity;

use FOS\OAuthServerBundle\Entity\Client as BaseClient;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table("oauth2_clients")
 * @ORM\Entity
 */
class Client extends BaseClient
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    public function __construct()
    {
        parent::__construct();
    }
}
<?php
// src/Acme/ApiBundle/Entity/AccessToken.php

namespace Acme\ApiBundle\Entity;

use FOS\OAuthServerBundle\Entity\AccessToken as BaseAccessToken;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table("oauth2_access_tokens")
 * @ORM\Entity
 */
class AccessToken extends BaseAccessToken
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\ManyToOne(targetEntity="Client")
     * @ORM\JoinColumn(nullable=false)
     */
    protected $client;

    /**
     * @ORM\ManyToOne(targetEntity="User")
     */
    protected $user;
}
<?php
// src/Acme/ApiBundle/Entity/RefreshToken.php

namespace Acme\ApiBundle\Entity;

use FOS\OAuthServerBundle\Entity\RefreshToken as BaseRefreshToken;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table("oauth2_refresh_tokens")
 * @ORM\Entity
 */
class RefreshToken extends BaseRefreshToken
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\ManyToOne(targetEntity="Client")
     * @ORM\JoinColumn(nullable=false)
     */
    protected $client;

    /**
     * @ORM\ManyToOne(targetEntity="User")
     */
    protected $user;
}
<?php
// src/Acme/ApiBundle/Entity/AuthCode.php

namespace Acme\ApiBundle\Entity;

use FOS\OAuthServerBundle\Entity\AuthCode as BaseAuthCode;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table("oauth2_auth_codes")
 * @ORM\Entity
 */
class AuthCode extends BaseAuthCode
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * @ORM\ManyToOne(targetEntity="Client")
     * @ORM\JoinColumn(nullable=false)
     */
    protected $client;

    /**
     * @ORM\ManyToOne(targetEntity="User")
     */
    protected $user;
}

You can now update your database schema :

php app/console doctrine:schema:update --force

You should have the following tables created :

mysql> describe users;
+-----------------------+--------------+------+-----+---------+----------------+
| Field                 | Type         | Null | Key | Default | Extra          |
+-----------------------+--------------+------+-----+---------+----------------+
| id                    | int(11)      | NO   | PRI | NULL    | auto_increment |
| username              | varchar(255) | NO   |     | NULL    |                |
| username_canonical    | varchar(255) | NO   | UNI | NULL    |                |
| email                 | varchar(255) | NO   |     | NULL    |                |
| email_canonical       | varchar(255) | NO   | UNI | NULL    |                |
| enabled               | tinyint(1)   | NO   |     | NULL    |                |
| salt                  | varchar(255) | NO   |     | NULL    |                |
| password              | varchar(255) | NO   |     | NULL    |                |
| last_login            | datetime     | YES  |     | NULL    |                |
| locked                | tinyint(1)   | NO   |     | NULL    |                |
| expired               | tinyint(1)   | NO   |     | NULL    |                |
| expires_at            | datetime     | YES  |     | NULL    |                |
| confirmation_token    | varchar(255) | YES  |     | NULL    |                |
| password_requested_at | datetime     | YES  |     | NULL    |                |
| roles                 | longtext     | NO   |     | NULL    |                |
| credentials_expired   | tinyint(1)   | NO   |     | NULL    |                |
| credentials_expire_at | datetime     | YES  |     | NULL    |                |
+-----------------------+--------------+------+-----+---------+----------------+
17 rows in set (0.00 sec)

mysql> describe oauth2_clients;
+---------------------+--------------+------+-----+---------+----------------+
| Field               | Type         | Null | Key | Default | Extra          |
+---------------------+--------------+------+-----+---------+----------------+
| id                  | int(11)      | NO   | PRI | NULL    | auto_increment |
| random_id           | varchar(255) | NO   |     | NULL    |                |
| redirect_uris       | longtext     | NO   |     | NULL    |                |
| secret              | varchar(255) | NO   |     | NULL    |                |
| allowed_grant_types | longtext     | NO   |     | NULL    |                |
+---------------------+--------------+------+-----+---------+----------------+
5 rows in set (0.00 sec)

mysql> describe oauth2_access_tokens;
+------------+--------------+------+-----+---------+----------------+
| Field      | Type         | Null | Key | Default | Extra          |
+------------+--------------+------+-----+---------+----------------+
| id         | int(11)      | NO   | PRI | NULL    | auto_increment |
| client_id  | int(11)      | NO   | MUL | NULL    |                |
| user_id    | int(11)      | YES  | MUL | NULL    |                |
| token      | varchar(255) | NO   | UNI | NULL    |                |
| expires_at | int(11)      | YES  |     | NULL    |                |
| scope      | varchar(255) | YES  |     | NULL    |                |
+------------+--------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)

mysql> describe oauth2_auth_codes;
+--------------+--------------+------+-----+---------+----------------+
| Field        | Type         | Null | Key | Default | Extra          |
+--------------+--------------+------+-----+---------+----------------+
| id           | int(11)      | NO   | PRI | NULL    | auto_increment |
| client_id    | int(11)      | NO   | MUL | NULL    |                |
| user_id      | int(11)      | YES  | MUL | NULL    |                |
| token        | varchar(255) | NO   | UNI | NULL    |                |
| redirect_uri | longtext     | NO   |     | NULL    |                |
| expires_at   | int(11)      | YES  |     | NULL    |                |
| scope        | varchar(255) | YES  |     | NULL    |                |
+--------------+--------------+------+-----+---------+----------------+
7 rows in set (0.00 sec)

mysql> describe oauth2_refresh_tokens;
+------------+--------------+------+-----+---------+----------------+
| Field      | Type         | Null | Key | Default | Extra          |
+------------+--------------+------+-----+---------+----------------+
| id         | int(11)      | NO   | PRI | NULL    | auto_increment |
| client_id  | int(11)      | NO   | MUL | NULL    |                |
| user_id    | int(11)      | YES  | MUL | NULL    |                |
| token      | varchar(255) | NO   | UNI | NULL    |                |
| expires_at | int(11)      | YES  |     | NULL    |                |
| scope      | varchar(255) | YES  |     | NULL    |                |
+------------+--------------+------+-----+---------+----------------+
6 rows in set (0.00 sec)

Add Oauth2 client

The following step consists in adding a new OAuth2 client. The documentation is not very clear on that point, the following code can be injected in a command to create new client. In our case, we need only one client, so I add the client manually with a simple SQL query :

INSERT INTO `oauth2_clients` VALUES (NULL, '3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4', 'a:0:{}', '4ok2x70rlfokc8g0wws8c8kwcokw80k44sg48goc0ok4w0so0k', 'a:1:{i:0;s:8:"password";}');

## Create admin user

We are going to use the command fos:user:create, provided by FOSUserBundle :

$ php app/console fos:user:create
Please choose a username:admin
Please choose an email:admin@example.com
Please choose a password:admin
Created user admin

Create a REST controller

We can now create a REST controller to deliver a very simple resource, so that we can test that our setup is working properly.

The controller

<?php

// src/Acme/ApiBundle/Controller/DemoController.php

namespace Acme\ApiBundle\Controller;

use FOS\RestBundle\Controller\FOSRestController;

class DemoController extends FOSRestController
{
    public function getDemosAction()
    {
        $data = array("hello" => "world");
        $view = $this->view($data);
        return $this->handleView($view);
    }
}

### The route configuration

# src/Acme/ApiBundle/Resources/config/routing.yml
acme_api_demos:
    type: rest
    resource: Acme\ApiBundle\Controller\DemoController

## Check OAuth2 is working

NOTE : the following commands make use of the HTTPie library. Make sure it is installed on your system before using it.

NOTE 2 : the following commands assume you are running Symfony with the built-in HTTP server. Adapt to fit your configuration.

$ http GET http://localhost:8000/app_dev.php/links
HTTP/1.1 401 Unauthorized
Cache-Control: no-store, private
Connection: close
Content-Type: application/json
...

{
    "error": "access_denied",
    "error_description": "OAuth2 authentication required"
}

We are not welcome here :(

We should now request an Access Token using the client and the user we created earlier. Notice the client_id parameter is a concatenation of the client id, an underscore and the client randomId :

$ http POST http://localhost:8000/app_dev.php/oauth/v2/token \
    grant_type=password \
    client_id=1_3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4 \
    client_secret=4ok2x70rlfokc8g0wws8c8kwcokw80k44sg48goc0ok4w0so0k \
    username=admin \
    password=admin
HTTP/1.1 200 OK
Cache-Control: no-store, private
Connection: close
Content-Type: application/json
...

{
    "access_token": "MDFjZGI1MTg4MTk3YmEwOWJmMzA4NmRiMTgxNTM0ZDc1MGI3NDgzYjIwNmI3NGQ0NGE0YTQ5YTVhNmNlNDZhZQ",
    "expires_in": 3600,
    "refresh_token": "ZjYyOWY5Yzg3MTg0MDU4NWJhYzIwZWI4MDQzZTg4NWJjYzEyNzAwODUwYmQ4NjlhMDE3OGY4ZDk4N2U5OGU2Ng",
    "scope": null,
    "token_type": "bearer"
}

We can use the Acces Token we've just been given to authenticate on the next request :

$ http GET http://ledzep.dev:8000/app_dev.php/links \
    "Authorization:Bearer MDFjZGI1MTg4MTk3YmEwOWJmMzA4NmRiMTgxNTM0ZDc1MGI3NDgzYjIwNmI3NGQ0NGE0YTQ5YTVhNmNlNDZhZQ"
HTTP/1.1 200 OK
Cache-Control: no-cache
Connection: close
Content-Type: application/json
...

{
    "hello": "world"
}

User information

Get current authenticated user

<?php

use use Symfony\Component\Security\Core\Exception\AccessDeniedException;

// ...
class DemoController extends FOSRestController
{
    // ...
    public function getDemosAction()
    {
        $user = $this->get('security.context')->getToken()->getUser();

        //...
        // Do something with the fully authenticated user.
        // ...
    }
    // ...
}

Check user grants

<?php

use use Symfony\Component\Security\Core\Exception\AccessDeniedException;

// ...
class DemoController extends FOSRestController
{
    // ...
    public function getDemosAction()
    {
        if ($this->get('security.context')->isGranted('ROLE_JCVD') === FALSE) {
            throw new AccessDeniedException();
        }

        // ...
    }
    // ...
}
@FlorianKromer
Copy link

FlorianKromer commented Sep 4, 2016

Thank you !
As suggested by @nothingaa, you can create a doctrine fixture to create a Client.
In security.yml you can excluse the doc url from NelmioDocBundle

firewalls:
       api:
            pattern: ^/api(?!/doc)                     # All URLs are protected except api/doc

@DIOHz0r
Copy link

DIOHz0r commented Oct 23, 2016

@tjamps and all developers....

To allow user to login by username or email at the API you have to change this two settings in this guide...

# app/config/security.yml
    providers:
        fos_userbundle:
            id: fos_user.user_provider.username_email

and

# app/config/config.yml
fos_oauth_server:
    service:
        fos_user.user_provider.username_email

@rodrigolopezguerra
Copy link

rodrigolopezguerra commented Dec 22, 2016

@DIOHz0r thanks ! take in account that fos_user.user_manager is deprecated and will give you and error.

as described in : FriendsOfSymfony/FOSUserBundle#2272

i used fos_user.user_provider.username , and worked like a charm

@JasonBenett
Copy link

JasonBenett commented Jan 7, 2017

It works for me with Symfony3, except the "service" part of the the "fos_oauth_server" section in config.yml. It has to be updated as described by @DIOHz0r

This is my first complex API so THANK YOU!

@grago
Copy link

grago commented Jan 26, 2017

Just got this working after days of searching for the most suitable solution for my client/server application. Thanks a lot for this great tutorial

@xorgxx
Copy link

xorgxx commented Feb 8, 2017

hi, thank's for this tuto !!. for me in SF3.2 it das not work, it give back .json but never ask for security level.

@lkainers
Copy link

lkainers commented Feb 10, 2017

in SF 3
if ($this->get('security.context')->isGranted('ROLE_JCVD') === FALSE)
does not work, but
if ($this->get('security.token_storage')->getToken()->getUser()->hasRole('ROLE_JCVD') === FALSE)
does

@clavier-souris
Copy link

clavier-souris commented Feb 20, 2017

@lkainers You should use

if ($this->get('security.authorization_checker')->isGranted('ROLE_JCVD') === FALSE){
// Do things
}

or if in Controller extending SF3 base controller

if ($this->isGranted('ROLE_JCVD') === FALSE){
// Do things
}

This is because AuthorizationChecker::isGranted() does not only check Role existence. There can be Voters that check arbitrary properties in your application

@JohannesTriooz
Copy link

JohannesTriooz commented Mar 24, 2017

Hello symfony comunity!
I am new with symfony and made already some testprojects and liveprojects. It works really fine. But now i have to write an API for a very big project. So i googled and found this result here. I am using the current smyfony 3 version. If i follow step by step this "tutorial" and start with the line "http GET http://localhost:8000/app_dev.php/links" i get a 404 error. The Exception is "No route found for "GET /links". Can please anybody help me with this problem?

Tank you for your attention.

@dariassoft
Copy link

dariassoft commented Mar 25, 2017

@JohannesTriooz first you must do this from terminal to Run your application:
1. Execute the php bin/console server:start command.
2. Browse to the http://localhost:8000 URL.

@Pherserk
Copy link

Pherserk commented May 2, 2017

This way _wdt and _profiler are under security, a special rule should be added to allow them in security.yml to make them always accessibile.

@Nebnoma
Copy link

Nebnoma commented Jun 26, 2017

Please does somebody know how to use it for connection throught web or mobile application?

@petargeorgiev123
Copy link

petargeorgiev123 commented Aug 13, 2017

Calling http://localhost:8000/app_dev.php/oauth/v2/token I am getting this error. I have changed the /Entity to /Model into User.php 'use FOS\UserBundle\Model\User as BaseUser'; since the Entity is not found

Type error: Argument 5 passed to FOS\OAuthServerBundle\Storage\OAuthStorage::__construct() must implement interface Symfony\Component\Security\Core\User\UserProviderInterface or be null, instance of FOS\UserBundle\Doctrine\UserManager given

Any clue which can be the error?

@petargeorgiev123
Copy link

petargeorgiev123 commented Aug 13, 2017

Found a solution.
Please replace user_provider: fos_user.user_manager with user_provider: fos_user.user_provider.username

@ddfire
Copy link

ddfire commented Aug 23, 2017

Hello,
How i use the refresh_token ??? can anyone please point me to a curl example or any example on how to use the refresh_token to get a new token using this bundles? thanks!!!!!

@bi40
Copy link

bi40 commented Aug 28, 2017

Good Tutorial ;)

@spam312sn
Copy link

spam312sn commented Sep 24, 2017

Thank's! But in app/config/config.yml should be

fos_oauth_server:
    service:
        user_provider: fos_user.user_provider

Instead of fos_user.user_manager

FriendsOfSymfony/FOSOAuthServerBundle/issues/445

@shoebaamir7
Copy link

shoebaamir7 commented Oct 15, 2017

How can I fix it..!
At this step "php app/console doctrine:schema:update --force", I'm getting this error

PHP Fatal error: Uncaught Symfony\Component\Debug\Exception\ClassNotFoundException: Attempted to load class "AcmeApiBundle" from namespace "Acme\ApiBundle". Did you forget a "use" statement for another namespace? in C:\xampp\htdocs\api\app\AppKernel.php:25 Stack trace: #0 C:\xampp\htdocs\api\vendor\symfony\symfony\src\Symfony\Component\HttpKernel\Kernel.php(431): AppKernel->registerBundles() #1 C:\xampp\htdocs\api\vendor\symfony\symfony\src\Symfony\Component\HttpKernel\Kernel.php(128): Symfony\Component\HttpKernel\Kernel->initializeBundles() #2 C:\xampp\htdocs\api\vendor\symfony\symfony\src\Symfony\Bundle\FrameworkBundle\Console\Application.php(67): Symfony\Component\HttpKernel\Kernel->boot() #3 C:\xampp\htdocs\api\vendor\symfony\symfony\src\Symfony\Component\Console\Application.php(120): Symfony\Bundle\FrameworkBundle\Console\Application->doRun(Object(Symfony\Component\Console\Input\ArgvInput), Object(Symfony\Component\Console\Output\ConsoleOutput)) #4 C:\xampp\htdocs\api\app\console(27): Symfony\Component\Console\Applicatio in C:\xampp\htdocs\api\app\AppKernel.php on line 25

@shoebaamir7
Copy link

shoebaamir7 commented Oct 15, 2017

Fixed the issue,
replaced autoload part with:

"autoload": {
"psr-4": {
"": "src/"
},
"classmap": [
"app/AppKernel.php",
"app/AppCache.php"
]
},

@dmcfaul
Copy link

dmcfaul commented Nov 3, 2017

Great guide! One issue I ran into with this: if you're consuming/authenticating the api from a javascript app you'll probably need to handle CORS issues. I installed the NelmioCorsBundle (https://github.com/nelmio/NelmioCorsBundle) and after tweaking it's config section to point to the /oauth/* routes it worked perfectly!

@blixit
Copy link

blixit commented Nov 9, 2017

Great !! I spent a week trying to set the bundle config, setting and resetting the security (providers, listenners, ...)
Reading your document saved my weekend THANK YOU !!

@rsehbani
Copy link

rsehbani commented Nov 30, 2017

its more interesting for the begining

@tups
Copy link

tups commented Dec 27, 2017

Thank you, it really helped me to start my API.

@hristonev
Copy link

hristonev commented Mar 3, 2018

Guys, how to get current Client in FOSRestController (my Controller)? I can get User via security.token_storage but since I'll have resource restrictions based on client I need client_id too.

Copy link

ghost commented Mar 19, 2018

Hi!
Thank you, it really helped me to start my API, so i have an update:
to solve this error: "oauth2 Call to a member function loadUserByUsername" use this:

app/config/config.yml

fos_oauth_server:
...

service:
    user_provider: fos_user.user_provider.username

@mamura
Copy link

mamura commented Apr 16, 2018

I'm doing this tutorial right now and this is my first error, still in bundle confiurations:
The child node "from_email" at path "fos_user" must be configured.

@mamura
Copy link

mamura commented Apr 16, 2018

I fix it add this lines in config.yml file under fos_user configs

from_email:
address: you@example.com
sender_name: You

@AlainT
Copy link

AlainT commented Oct 12, 2018

hello folks,
trying this gist with Symfony 4 gives

In AccessToken.php line 13:
                                                                                                                                     
  Compile Error: Declaration of App\Entity\AccessToken::setUser(?App\Entity\User $user) must be compatible with FOS\OAuthServerBund  
  le\Model\TokenInterface::setUser(Symfony\Component\Security\Core\User\UserInterface $user)    

any idea ? (i'm new to V4 and OAuthServerBundle...)

@steve-kouna
Copy link

steve-kouna commented Jan 3, 2019

{
"error": "unauthorized_client",
"error_description": "The grant type is unauthorized for this client_id"
}

@somoza
Copy link

somoza commented Mar 23, 2020

How to use the refresh_token and when ?

Do you have a sample implementation please ?

To refresh the token add permission on the client stored on DB. Replace the last column by:

a:2:{i:0;s:8:"password";i:1;s:13:"refresh_token";}

Query:

INSERT INTO `oauth2_clients` VALUES (NULL, '3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4', 'a:0:{}', '4ok2x70rlfokc8g0wws8c8kwcokw80k44sg48goc0ok4w0so0k', 'a:2:{i:0;s:8:"password";i:1;s:13:"refresh_token";}');
## Create admin user

And the API parameters should seem like this:

{
	"grant_type":"refresh_token",
    "client_id":"1_3bcbxd9e24g0gk4swg0kwgcwg4o8k8g4g888kwc44gcc0gwwk4",
    "client_secret":"4ok2x70rlfokc8g0wws8c8kwcokw80k44sg48goc0ok4w0so0k",
    "refresh_token":"ZDQyYTJiMmEzMGRmMDU1ZDg1Y2QzYTAzMWEwZWQ1ZGZiOWZlOGQ3NzViNzhmYWUzMDIxMzE5MGNkNmZlMmEyZQ",
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment