feature: add doc for #230 #231
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
soyuka
reviewed
Jun 27, 2017
core/security.md
Outdated
| @@ -6,6 +6,52 @@ section. | |||
| Using API Platform, you can leverage all security features provided by the [Symfony Security component](http://symfony.com/doc/current/book/security.html). | |||
| For instance, if you wish to restrict the access of some endpoints, you can use [access controls directives](http://symfony.com/doc/current/book/security.html#securing-url-patterns-access-control). | |||
|
|
|||
| You can also add security directly in the entity using the [Symfony's access control expressions](https://symfony.com/doc/current/expressions.html#security-complex-access-controls-with-expressions). | |||
| Here is a little exemple for this : | |||
There was a problem hiding this comment.
Since 2.1, you can add security through Symfony's access control expressions in your entities.
Here is an example:
soyuka
reviewed
Jun 27, 2017
core/security.md
Outdated
| Here is a little exemple for this : | ||
|
|
||
| ```php | ||
|
|
soyuka
reviewed
Jun 27, 2017
core/security.md
Outdated
| /** | ||
| * Secured resource. | ||
| * | ||
| * @author Kévin Dunglas <[email protected]> |
soyuka
reviewed
Jun 27, 2017
core/security.md
Outdated
| * @ORM\GeneratedValue(strategy="AUTO") | ||
| */ | ||
| public $id; | ||
| /** |
|
Thanks for handling this Hamza! Can you just add sentence explaining what the example do? |
|
Uhh... I've never noticed this, but |
|
By the way this is documenting api-platform/core#938 |
|
@dunglas, I will update this asap :p |
|
@Simperfit, can you replace |
|
ping @Simperfit |
Simperfit
force-pushed
the
feature/add-security
branch
from
e0a78d0 to
18678c3
Compare
|
done |
meyerbaptiste
requested changes
Sep 8, 2017
core/security.md
Outdated
| } | ||
| ``` | ||
|
|
||
| This exemple is going to allow only fetching the book related to the current user, if he try to fetch a book that is not linked to his account that will not return the resource and only admins are able to create books which means that a user could not create a book. |
There was a problem hiding this comment.
- Add a dot here:
current user. If he is linked to his account, that will- Replace
trybytries return the resource. In addition, only admins are
meyerbaptiste
requested changes
Sep 8, 2017
core/security.md
Outdated
| * Secured resource. | ||
| * | ||
| * @ApiResource( | ||
| * attributes={"is_granted"="has_role('ROLE_USER')"}, |
added 2 commits
September 8, 2017 16:38
meyerbaptiste
requested changes
Sep 8, 2017
core/security.md
Outdated
| } | ||
| ``` | ||
|
|
||
| This exemple is going to allow only fetching the book related to the current user. if he tries to fetch a book that is linked to his account, that will not return the resource. In addition, only admins are are able to create books which means that a user could not create a book. |
|
It would be nice to mention these variables, but it can be done in a future PR: https://github.com/api-platform/core/blob/7d85bbcf60f1aa1822384e8f330f2fe3c594e809/src/Security/EventListener/DenyAccessListener.php#L105-L116 |
meyerbaptiste
approved these changes
Sep 8, 2017
meyerbaptiste
requested changes
Sep 8, 2017
core/security.md
Outdated
| public $title; | ||
|
|
||
| /** | ||
| * @ORM\Column(type="text") |
There was a problem hiding this comment.
It should be string or a relation.
meyerbaptiste
approved these changes
Sep 8, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.