Skip to content

Document second_factors field#49016

Merged
Joerger merged 7 commits intomasterfrom
joerger/second-factors-docs
Jan 6, 2025
Merged

Document second_factors field#49016
Joerger merged 7 commits intomasterfrom
joerger/second-factors-docs

Conversation

@Joerger
Copy link
Copy Markdown
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

@aws-amplify-us-west-2
Copy link
Copy Markdown

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
Copy link
Copy Markdown
Contributor

🤖 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
Copy link
Copy Markdown
Contributor

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

Comment thread docs/pages/includes/config-reference/auth-service.yaml Outdated
Comment thread docs/pages/reference/terraform-provider/data-sources/auth_preference.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions
Copy link
Copy Markdown
Contributor

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

Comment thread integrations/terraform/tfschema/types_terraform.go
Comment thread api/proto/teleport/legacy/types/types.proto Outdated
Comment thread api/proto/teleport/legacy/types/types.proto
Copy link
Copy Markdown
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
Copy Markdown
Contributor Author

@Joerger Joerger Jan 2, 2025

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 2, 2025

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
@Joerger Joerger deleted the joerger/second-factors-docs branch January 6, 2025 20:16
@public-teleport-github-review-bot
Copy link
Copy Markdown

@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
* 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.
github-merge-queue Bot pushed a commit that referenced this pull request Jan 9, 2025
* 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.
carloscastrojumo pushed a commit to carloscastrojumo/teleport that referenced this pull request Feb 19, 2025
* 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants