Option to configure custom token user id claim #783
Merged
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.
Proposed changes
Add possibility to use alternative claim in token to extract user ID:
token_user_id_claim
option. At this moment due to how Centrifugo works with tokens it only supportsuser_id
as alternative claim name. I.e the only possible way to enable the option is:Probably, in the future we can extend the option to support any custom claim, but that will require bigger refactoring.
By default Centrifugo uses
sub
to extract user ID - this is defined in JWT spec and should remain the recommended way to pass user ID, this should be emphasised in the documentation.Setting alternative user id claim also affects subscription tokens, like any other token options. To use different config for subscription tokens Centrifugo provides separate_subscription_token_config option.
UPD. the description here is not quite actual anymore - see #783 (comment)