[Security] Update custom authenticator docs to include identifier normalization #20636
Conversation
This file contains 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
xabbuh
reviewed
Feb 7, 2025
Improve the documentation for custom authenticators by detailing the concept of user identifier normalization. Introduced the `NormalizedUserBadge` example to demonstrate how to simplify and standardize identifiers. Clarified how normalization avoids duplicates and ensures consistent user recognition.
b58b83b to
a7df8a2
Compare
alamirault
reviewed
Mar 23, 2025
Comment on lines
+270
to
+274
| You can optionally pass a user identifier normalizer as third argument to the | ||
| ``UserBadge``. This callable receives the ``$userIdentifier`` | ||
| and must return a normalized user identifier as a string. | ||
|
|
||
| .. versionadded:: 7.3 |
There was a problem hiding this comment.
New section is not correctly rendered:
I don't know how to fix it
Comment on lines
+320
to
+325
| .. note:: | ||
|
|
||
| Similarly, Google normalizes email addresses so that "john.doe", "j.hon.d.oe", | ||
| and "johndoe" all correspond to the same account. | ||
| This involves removing dots and converting the email address to lowercase | ||
| (though normalization specifics depend on your use case). |
There was a problem hiding this comment.
With the other note below, I'm not sure this one is needed
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.
Fixes #20632
Improve the documentation for custom authenticators by detailing the concept of user identifier normalization. Introduced the
NormalizedUserBadgeexample to demonstrate how to simplify and standardize identifiers.