dwyl/learn-json-web-tokens

misleading information on jwt fields

Open

#94 opened on Jan 3, 2019

View on GitHub
 (1 comment) (3 reactions) (0 assignees)JavaScript (267 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (4,175 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

sub: subject of the token (rarely used)

Sub should be your userID, and you should use it as such.

those fields are used in openId and it is a good idea to at least mention it and update at least the mandatory fields.

sub REQUIRED. Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client, e.g., 24400320 or AItOawmwtWwcT0k51BayewNvutrJUqsvl6qs7A4. It MUST NOT exceed 255 ASCII characters in length. The sub value is a case sensitive string.

your users will change names and such, but the ID will stay constant. This is a very very very important field.

Contributor guide

Research direction
Update the documentation to correctly describe the 'sub' field as a unique subject identifier (e.g., user ID) with reference to OpenID Connect spec.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic knowledge of JWT
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80