Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document second_factors field #49016

Merged
merged 7 commits into from
Jan 6, 2025
Merged

Document second_factors field #49016

merged 7 commits into from
Jan 6, 2025

Conversation

Joerger
Copy link
Contributor

@Joerger Joerger commented Nov 14, 2024

Update documentation to mention second_factors instead of second_factor.

Also update the test plan.

Note: I decided not to touch reduce-blast-radius.mdx as this page is out of date and should be covered by this separate issue - #48767

Docs follow up for #47233

@Joerger Joerger requested a review from ptgott November 14, 2024 21:42
@aws-amplify-us-west-2 AWS Amplify (us-west-2)
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-49016.d3pp5qlev8mo18.amplifyapp.com

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-dyyp3naz3-goteleport.vercel.app/docs/ver/preview

@Joerger Joerger force-pushed the joerger/second-factors-docs branch from 50627c4 to 80ef4ca Compare November 14, 2024 22:00
@Joerger Joerger added the no-changelog Indicates that a PR does not require a changelog entry label Nov 14, 2024
@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-n44w4iu9a-goteleport.vercel.app/docs/ver/preview

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-3u9zj2rj3-goteleport.vercel.app/docs/ver/preview

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-erhb868yp-goteleport.vercel.app/docs/ver/preview

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-jlfla8jrd-goteleport.vercel.app/docs/ver/preview

@Joerger Joerger force-pushed the joerger/second-factors-docs branch from 5d1e3f5 to d39c3bd Compare December 20, 2024 22:12
@Joerger Joerger requested a review from zmb3 December 20, 2024 22:12
@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-fcvhbdppv-goteleport.vercel.app/docs

zmb3
zmb3 reviewed Dec 26, 2024
View reviewed changes
.github/ISSUE_TEMPLATE/webtestplan.md Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have a test that make sure you can't do something like second_factors: [ webauthn, on, off ]?

Copy link
Contributor Author

@Joerger Joerger Jan 2, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on and off aren't valid second_factors values, so you'd get a parsing error. The only valid values are webauthn, otp, and sso.

const (
	// secondFactorTypeOTPString is the string representation of SecondFactorType_SECOND_FACTOR_TYPE_OTP
	secondFactorTypeOTPString = "otp"
	// secondFactorTypeWebauthnString is the string representation of SecondFactorType_SECOND_FACTOR_TYPE_WEBAUTHN
	secondFactorTypeWebauthnString = "webauthn"
	// secondFactorTypeSSOString is the string representation of SecondFactorType_SECOND_FACTOR_TYPE_SSO
	secondFactorTypeSSOString = "sso"
)

@Joerger Joerger requested a review from zmb3 January 2, 2025 18:31
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 2, 2025 •
edited
Loading

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
joerger/second-factors-docs 526e716 3 ✅SUCCEED joerger-second-factors-docs 2025-01-06 19:40:27

@Joerger Joerger force-pushed the joerger/second-factors-docs branch from 13a960e to 9c9b7ca Compare January 6, 2025 18:33
@Joerger Joerger enabled auto-merge January 6, 2025 18:33
@Joerger Joerger added this pull request to the merge queue Jan 6, 2025
Merged via the queue into master with commit 3ebf269 Jan 6, 2025
45 checks passed
@Joerger Joerger deleted the joerger/second-factors-docs branch January 6, 2025 20:16
@public-teleport-github-review-bot
Copy link

@Joerger See the table below for backport results.

Branch Result
branch/v17 Failed

Joerger added a commit that referenced this pull request Jan 6, 2025
@Joerger
Document second_factors field (#49016)
f5d1593 
* Document second_factors; Update test plan.

* Update proto comment; Update terraform docs.

* Clarify second_factors reference.

* Fix docs lint.

* Address comments.

* Address marco's comment.
This was referenced Jan 6, 2025
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nklaassen nklaassen nklaassen approved these changes

@marcoandredinis marcoandredinis marcoandredinis approved these changes

@zmb3 zmb3 Awaiting requested review from zmb3

Assignees
No one assigned
Labels
backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Joerger @marcoandredinis @zmb3 @nklaassen