minor #19675 doc: Access Token Authentication - added a disambiguation on what the identifier is (glukose)

javiereguiluz · javiereguiluz · commit 22e694cf0f45 · 2024-03-25T16:15:10.000+01:00
This PR was submitted for the 7.0 branch but it was merged into the 6.4 branch instead. Discussion ---------- doc: Access Token Authentication - added a disambiguation on what the identifier is Users could be confused seeing getUserId() and returning a user Id instead of the identifier defined in the app, such as an email. Well I got stuck a fair amount of time on this, this comment might help others ? Commits ------- 995b8ac doc: added a disambiguation on what the identifier is
diff --git a/security/access_token.rst b/security/access_token.rst
@@ -97,6 +97,7 @@ This handler must implement
             }
 
             // and return a UserBadge object containing the user identifier from the found token
+            // the user identifier being an email, a username and not necessarily an Id
             return new UserBadge($accessToken->getUserId());
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -97,6 +97,7 @@ This handler must implement`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`// and return a UserBadge object containing the user identifier from the found token`
	`100`	`+ // the user identifier being an email, a username and not necessarily an Id`
`100`	`101`	`return new UserBadge($accessToken->getUserId());`
`101`	`102`	`}`
`102`	`103`	`}`