Skip to content

Add notes on usage of ApiProperty security_post_denormalize. #1349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alanpoulain merged 1 commit into from
May 6, 2021
+4 −2
Merged

Add notes on usage of ApiProperty security_post_denormalize. #1349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions core/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ class Book
/**
* @var string Property viewable and writtable only by users with ROLE_ADMIN
*
* @ApiProperty(security="is_granted('ROLE_ADMIN')")
* @ApiProperty(security="is_granted('ROLE_ADMIN')", security_post_denormalize="is_granted('UPDATE', object)")
*/
private $adminOnlyProperty;
}
Expand All @@ -101,11 +101,13 @@ In this example:
* Only users having [the role](https://symfony.com/doc/current/security.html#roles) `ROLE_ADMIN` can create a new resource (configured on the `post` operation)
* Only users having the `ROLE_ADMIN` or owning the current object can replace an existing book (configured on the `put` operation)
* Only users having the `ROLE_ADMIN` can view or modify the `adminOnlyProperty` property. Only users having the `ROLE_ADMIN` can create a new resource specifying `adminOnlyProperty` value.
* Only users that are granted the `UPDATE` attribute on the book (via a voter) can write to the field

Available variables are:

* `user`: the current logged in object, if any
* `object`: the current resource, or collection of resources for collection operations
* `object`: the current resource, or collection of resources for collection operations (note: this is `null` for update/create operations)
* `previous_object`: (`security_post_denormalize` only) a clone of `object`, before modifications were made - this is `null` for create operations
* `request`: the current request

Access control checks in the `security` attribute are always executed before the [denormalization step](serialization.md).
Expand Down