added oauth2 documentation #182

iCodr8 · 2017-03-12T21:04:02Z

Documentation for the OAuth2 integration as promised in #180.

dunglas · 2017-03-20T10:51:34Z

core/oauth2.md

@@ -0,0 +1,340 @@
+# Adding a OAuth2 authentication using `FOSOAuthServerBundle`


We use Title Case:

Adding a OAuth2 Authentication using `FOSOAuthServerBundle`

dunglas · 2017-03-20T10:52:17Z

core/oauth2.md

@@ -0,0 +1,340 @@
+# Adding a OAuth2 authentication using `FOSOAuthServerBundle`
+
+> [OAuth](https://oauth.net/2/) is an open standard for authorization, commonly used as a way for Internet users to authorize websites or applications to access their information on other websites but without giving them the passwords.[1] This mechanism is used by companies such as Google, Facebook, Microsoft and Twitter to permit the users to share information about their accounts with third party applications or websites.


Can you remove the [1] please as the reference is not in this document.

dunglas · 2017-03-20T10:53:10Z

core/oauth2.md

+
+public function registerBundles()
+{
+    $bundles = array(


Can you use the short array syntax please?

dunglas · 2017-03-20T10:53:49Z

core/oauth2.md

+}
+```
+
+## Create oauth2 entites


Creating Entities to Store OAuth2 Data

dunglas · 2017-03-20T10:54:59Z

core/oauth2.md

+
+Add all the following classes to your entities and run `php bin/console doctrine:schema:update --force`:
+
+`AppBundle/Entity/AccessToken.php`


We put the filename as a comment just after <?php directly in the code sample (same for all other files).

dunglas · 2017-03-20T10:58:16Z

core/oauth2.md

+        $client->setAllowedGrantTypes([$grantType]);
+        $clientManager->updateClient($client);
+
+        $output->writeln(sprintf("<info>The client <comment>%s</comment> was created with <comment>%s</comment> as public id and <comment>%s</comment> as secret</info>",


Can you switch to single quotes?

dunglas · 2017-03-20T10:59:02Z

core/oauth2.md

+Add the following code to your `app/config/config.yml` and replace the `clientId` and `clientSecret` with the data from the generated application client with the `client_credentials` grant type.
+
+```yaml
+# ...


# app/config/config.yml

dunglas · 2017-03-20T11:00:01Z

core/oauth2.md

+# ...
+fos_oauth_server:
+    db_driver: orm       # Drivers available: orm, mongodb, or propel
+    client_class:        AppBundle\Entity\Client


Can you remove indentation and put class names into single quotes (it can cause issues without single quotes when the class name contains special chars like \t)

dunglas · 2017-03-20T11:00:38Z

core/oauth2.md

+    # ...
+    oauth2:
+        enabled: true
+        clientId: 'enter-swagger-api-documentation-client-id'


IMO it should be done using parameters.yml.dist.

dunglas · 2017-03-20T11:00:48Z

core/oauth2.md

+```
+
+That's all, now your OAuth2 authentication should work.
+


Extra line to remove.

dunglas · 2017-03-20T11:02:06Z

This is awesome! Thank you very much for this tutorial it's really appreciated. I just left some minor comments.

Padam87

Thanks, works great! (2 small comments from me)

Padam87 · 2017-05-05T20:44:01Z

core/oauth2.md

+php bin/console oauth:client:create password
+
+# Application client
+php bin/console oauth:client:create client_credentials


I think the comments are switched. The 2nd one should be the swagger one.

Padam87 · 2017-05-05T20:57:26Z

core/oauth2.md

+        user_provider: fos_user.user_provider.username
+        options:
+            access_token_lifetime: 10800
+            supported_scopes: user


This is a bit weird, as it will add ROLE_USER to every authentication, even the client_credentials one, when no user is present.

This may lead to problems... in my case, the user is not allowed to list all users:

access_control: - { path: ^/users, roles: [ ROLE_ADMIN ] }

but it will appear in the docs, and the request fails. I think there should be a hint about this.

Also, from now on user should be null checked even if the ROLE_USER is available.

Is this ever got into official docs? Installing fresh api-platform, doesn't contain this .md file.
Where is this file located, where we can read the full doc?

The full docs are available here: https://api-platform.com/docs
And also in this GitHub repository.

I really want to merge this one, but it need to be rebased and finished first...

iCodr8 · 2018-12-13T16:17:16Z

I do not have the branch anymore and can't fix that.

MelvinLoos · 2019-03-06T23:47:40Z

Wait so after all this works this never got merged? Is anyone working on oauth integrations docs at all? If not I might have some time on my hands this week and could give it a try

EDIT: Ah looking at the changes I see now that the structure of the documentation has completely changed. So this will need to be completely restructured. @dunglas am I correct in noticing that the index file that was manually edited in this pull request is now dynamically generated based on the markdown files?

dunglas · 2019-03-07T00:07:22Z

The raw text is still available in the diff tab. It would be nice to copy and finish it!

MelvinLoos · 2019-03-07T00:10:21Z

Quick response ^^ I added a question in my edited comment above.

And yes I was already looking at https://github.com/api-platform/docs/pull/182.diff to distill the changes.

bastoune · 2020-03-10T12:59:05Z

Hi, is this going to be merged ?
Is that doc still relevant ?

Daniel Kiesel added 2 commits March 12, 2017 21:58

added oauth2 documentation

6c986a1

optimized documentation

8c8f541

iCodr8 mentioned this pull request Mar 12, 2017

Add an example/tutorial for OAuth2 and Swagger #180

Closed

dunglas requested changes Mar 20, 2017

View reviewed changes

changed to newest config

ed356c9

dunglas mentioned this pull request Apr 5, 2017

How active oauth authenfification? api-platform/api-platform#271

Closed

Padam87 reviewed May 5, 2017

View reviewed changes

meyerbaptiste mentioned this pull request Jun 28, 2017

add access token on swagger UI api-platform/api-platform#286

Closed

soyuka mentioned this pull request Jul 25, 2017

How to add FOSUserBundle actions like login, register etc., in Swagger UI? api-platform/api-platform#365

Closed

Simperfit added the Needs Work label Feb 24, 2018

iCodr8 closed this Dec 13, 2018

imankurpatel000 mentioned this pull request May 23, 2020

Documentation for the OAuth2 integration #1113

Closed

		@@ -0,0 +1,340 @@
		# Adding a OAuth2 authentication using `FOSOAuthServerBundle`

		@@ -0,0 +1,340 @@
		# Adding a OAuth2 authentication using `FOSOAuthServerBundle`

		> [OAuth](https://oauth.net/2/) is an open standard for authorization, commonly used as a way for Internet users to authorize websites or applications to access their information on other websites but without giving them the passwords.[1] This mechanism is used by companies such as Google, Facebook, Microsoft and Twitter to permit the users to share information about their accounts with third party applications or websites.


		Add all the following classes to your entities and run `php bin/console doctrine:schema:update --force`:

		`AppBundle/Entity/AccessToken.php`

Uh oh!

added oauth2 documentation #182

added oauth2 documentation #182

Uh oh!

Conversation

iCodr8 commented Mar 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dunglas commented Mar 20, 2017

Uh oh!

Padam87 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Padam87 May 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iCodr8 commented Dec 13, 2018

Uh oh!

MelvinLoos commented Mar 6, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dunglas commented Mar 7, 2019

Uh oh!

MelvinLoos commented Mar 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bastoune commented Mar 10, 2020

Uh oh!

Uh oh!

iCodr8 commented Mar 12, 2017 •

edited

Loading

Padam87 May 5, 2017 •

edited

Loading

MelvinLoos commented Mar 6, 2019 •

edited

Loading

MelvinLoos commented Mar 7, 2019 •

edited

Loading