Merge pull request #3319 from lemoinem/features/acl-update-security-id

weaverryan · weaverryan · commit 06f2f74eac8e · 2013-12-23T14:36:05.000-08:00
[WCM][Security][Acl] Documentation for the new updateUserSecurityIdentity method in Dbal\MutableAclProvider
diff --git a/cookbook/security/acl_advanced.rst b/cookbook/security/acl_advanced.rst
@@ -45,6 +45,13 @@ Security Identities
 This is analog to the object identity, but represents a user, or a role in
 your application. Each role, or user has its own security identity.
 
+.. versionadded:: 2.5
+    For users, the security identity is based on the username. This means that,
+    if for any reason, a user's username was to change, you must ensure its
+    security identity is updated too. The method ``updateUserSecurityIdentity``
+    of the :class:`Symfony\\Component\\Security\\Acl\\Dbal\\MutableAclProvider`
+    class is there to handle the update.
+
 Database Table Structure
 ------------------------
 
