-
Notifications
You must be signed in to change notification settings - Fork 514
docs: Document requires_totp_mfa JWT claim #1281
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: dev
Are you sure you want to change the base?
Changes from 1 commit
3af68cc
b094812
c2e0383
0590fb3
5919d21
0818d01
9f87333
7c68af9
a36c3f0
0da31a0
58c3662
c7a8395
b51f444
6c8c214
838636c
4898daa
d7e55f1
fd97c9d
a00ad89
e7b49ab
0877a0e
5e0483d
8a6cb12
05ff0b0
183dec8
3e0c98f
124f7e7
06efd67
1f8f26c
5d24c72
71e3df0
1faaec4
32881f4
873fa62
28c96c6
04d35f5
0843d43
accd740
d76e5ee
1871277
fd02f18
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -42,6 +42,7 @@ Stack Auth JWTs contain standardized headers and claims that power authenticatio | |||||
| - **`project_id`**: Your Stack Auth project ID | ||||||
| - **`branch_id`**: The project branch (currently always `main`) | ||||||
| - **`refresh_token_id`**: ID of the associated refresh token | ||||||
| - **`requires_totp_mfa`**: Whether the user has TOTP multi-factor authentication enabled | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The added description says "Whether the user has TOTP multi-factor authentication enabled," but the internal OpenAPI spec in Consider aligning the docs with the existing internal description:
Suggested change
|
||||||
| - **`role`**: Always set to `authenticated` for valid users | ||||||
| - **`name`**: The user's display name (nullable) | ||||||
| - **`email`**: The user's primary email address (nullable) | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Citation: Based on commit c8b5168 "Add requires_totp_mfa to JWT". The commit added
requires_totp_mfatotokens.tsx,schema-fields.ts, and the example JWT injwt.mdx, but didn't add a description in the Stack Auth Specific Claims section. The field indicates whether the user has TOTP MFA enabled, as shown in the e2e tests inaccess-token-refresh.test.ts.View source