ENG-2471 - Passwordless loginIdType -> loginIdTypes#3668
Merged
wied03 merged 7 commits intofeature/issue1from Apr 28, 2025
Merged
ENG-2471 - Passwordless loginIdType -> loginIdTypes#3668wied03 merged 7 commits intofeature/issue1from
loginIdType -> loginIdTypes#3668wied03 merged 7 commits intofeature/issue1from
Conversation
spwitt
approved these changes
Apr 22, 2025
andrewpai
reviewed
Apr 27, 2025
| <LoginIdField login_id_type_field="loginIdType" /> | ||
| <LoginIdTypeField /> | ||
| <LoginIdField login_id_type_field="loginIdTypes" footer={ | ||
| <span>If a correct email address or username is supplied and the <code>code</code> returned in this API response is sent using the <a href="#send-passwordless-login">Send Passwordless Login</a> API, the the user will receive the message via their email address. If a phone number is supplied, then the user will receive the message via an SMS messenger.</span> |
Contributor
There was a problem hiding this comment.
This is a little confusing. Are you saying that if you call POST /api/passwordless/send using the code generated by this call, the send API will select the delivery method associated with the loginId supplied here? If that's the case then the following seems clearer to me. We'll also need to update the Send Passwordless Login description, as it currently only talks about email.
Suggested change
| <span>If a correct email address or username is supplied and the <code>code</code> returned in this API response is sent using the <a href="#send-passwordless-login">Send Passwordless Login</a> API, the the user will receive the message via their email address. If a phone number is supplied, then the user will receive the message via an SMS messenger.</span> | |
| <span> | |
| If you are using the <a href="#send-passwordless-login">Send Passwordless Login</a> API with the code returned by this call, that API will send a message using a delivery method appropriate for the `loginId` used here. If you supplied a username or email address `loginId`, the message will be sent via email. If you supplied a phone number `loginId` then the message will be delivered via an SMS messenger. | |
| </span> |
Contributor
Author
There was a problem hiding this comment.
Agreed it is confusing @andrewpai. Will accept your suggestion.
Contributor
Author
There was a problem hiding this comment.
Good catch. Pushed more send explanations.
Co-authored-by: Andy Pai <[email protected]>
andrewpai
approved these changes
Apr 28, 2025
wied03
added a commit
that referenced
this pull request
Aug 14, 2025
* label images that need updating (#3561) * label images that need updating Co-authored-by: Spencer Witt <[email protected]> * Add phoneNumber to form fields, basic reg (#3570) * Add phoneNumber to form fields, basic reg Co-authored-by: Spencer Witt * Tenant phone configuration (#3569) * Add themes from phone number gating and clickable link verification (#3577) * update generic connector page components (#3594) Update Generic Connector page components with new loginIdTypes and user.phoneNumber. Noticed the login/request.json was out of date and updated. * User list needs an update (#3619) * ENG-2364 - Add Various User API fields (#3599) ### Big changes This adds: * `user.phoneNumber` to the request/response * `user.identities` fields to the response (both search, retrieval, login, etc.) * new `verificationIds` to the response * User API `skipVerification` updates to include phone * Sample response updates ### Other Points * Tried to avoid veering into ENG-2023 but kinda got dragged in. * To make it easy to improve what I have here and not duplicate in 2 places, carved out a base MDX template for both search and single user responses. * Verified/reason, and value - should we have a table? Might that be more clear? * Should I avoid mentioning primary at all, as I casually do a few times? * I didn't see a logical place to explain how re-verification is different for phone, so parking for now * Note the callout on `user.verifiedInstant` * ENG-2465 - Add New Login API responses and fields (#3603) * ENG-2493 - Admin Create User - Update core concepts and forms info (#3634) * ENG-2413 - Phone number verified/claim additions (#3612) * Add loginIdTypes to MFA step-up (#3640) * Login record changes * document login record search response * document login record export changes * Fix post merge dupes * ENG-2471 - Passwordless `loginIdType` -> `loginIdTypes` (#3668) * ENG-2544 - Document how you can test a theme with `passwordEnabled` set to `false` (#3680) * ENG-2545 - Password fields now are not always shown (#3676) * ENG-1730 - Password changes (#3662) * add tenant.passwordEnabled field and registration form info (#3689) * add tenant.passwordEnabled field and registration form info * Missing Aside import * In API docs, refer to API field rather than GUI field (#3692) * ENG-2468 - webauthn bootstrap updates (#3694) * ENG-2548 - Passwordless form field docs (#3691) * Article updates * 1st round of image updates * Add a message template screenshot * Don't use remote code for files in our repo, and show the passwordless phone template * Add loginStrategy and explanation * Generator config * Add our new API fields * Add our new theme page * Add phone templates that were missed before * ENG-2002 - Send set password phone docs (#3705) * ENG-2633 - Clarify password required (#3713) * Took this opportunity to watermark all of the manage user/missed user index screenshots that need updating (not directly related to this PR, but noticed them) * Update astro/src/content/docs/apis/_user-request-body.mdx for the user.password field to reflect when it's required. Same for registration. * add tenant phoneConfiguration template fields (#3715) * add tenant phoneConfiguration template fields Co-authored-by: Andy Pai <[email protected]> * ENG-2619 Forgot password doc updates * start forgot password request changes * document when we attempt to deliver forgot password via SMS * use of loginIdTypes on change password with API key * tenant.phoneConfiguration.forgotPasswordTemplateId * new message template * ENG-1731 - Refresh token changes (#3729) * ENG-2292 - Search (#3734) * ENG-2025 - Document the identity verification API and phone gating (#3764) * ENG-1677 - Passwordless send phone rate limiting (#3773) 13a5d12 covered the screenshots already. Used the PR for that as a baseline. * Reaping updates (#3777) * Reapply change from 44aefc7 after merge * Application phone templates (#3793) * make a component for tenant/application phone configuration * rename override parameter to work for message templates * document application phone configurations in API * add application phone to sample JSON * mention message templates in applicationId template override parameter * Bhalsey/eng 2388/doc sms messages (#3813) * add phone default templates * add default message templates, document vars * ENG-2668 Application identities tab (#3815) * update tenant field docs for Identities tab * rename _email-templates component to _template-settings * make language inclusive of phone * rename application tab to Identities * set up password was in the wrong spot * linter - use markdown for images * roll back versions for fields shared between email and phone * rename identity.verified event to user.identity.verified (#3823) * magic links page updates (#3836) * update wording, add extra troubleshooting * separate out message template * ENG-2634 - Self serve account screenshots (#3811) * account management page * two-factor-authenticator page * Account updates * missed login * Missed webauthn bootstrap updates * Missed tenant settings * ENG-2458 - message template preview improvements (#3803) * Update values * format the table * PR feedback - move the table over here * PR feedback - fill out purpose more * Deal with issue 1 merge * ENG-2272 - Add new startup probe setting (#3810) * Add setting Co-authored-by: Andy Pai <[email protected]> * ENG-2790 - Password toggle refinements (#3821) * First cut * Refine the wording * ENG-2760 - Account self service password change notes (#3834) * Capture theme changes * Add missing fields * Update astro/src/content/docs/apis/_user-request-body.mdx Co-authored-by: Andy Pai <[email protected]> * PR feedback - simplify wording * Update astro/src/content/docs/customize/look-and-feel/upgrade.mdx Co-authored-by: Andy Pai <[email protected]> * Fix grammar in suggestion --------- Co-authored-by: Andy Pai <[email protected]> * add message template vars to table (#3847) * ENG-2848 - Correct Passwordless login UI field (#3846) * Passwordless login UI field * ENG-2853 update userState doc * Manager user/verification * ENG-2741 - `user.verifiedInstant` and import `user.verified` (#3795) * Fix import (and user.verified is no longer settable) * Update user response * Correct based on recent import PR * Add import info * ENG-2769 - Explain kickstart / singleton message templates, email templates, etc. better (#3850) * Bhalsey/eng 2849/tenant and users screenshots (#3851) * update tenant screenshots * updated core-concepts user screenshots * ENG-3055: self-service screenshot updates (#3855) * ENG-2851 - Blogs/Lifecycle screenshots (#3857) * Bhalsey/eng 2852/screenshots user verification (#3856) * verification pages * Update astro/src/components/docs/reference/_configuration-properties.mdx Co-authored-by: Maurice Sharp <[email protected]> * Update astro/src/content/docs/apis/_import-users-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Correct mobilePhone grammar in other places * Update astro/src/content/docs/apis/_import-users-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Update astro/src/components/docs/reference/_configuration-properties.mdx Co-authored-by: Maurice Sharp <[email protected]> * Update astro/src/content/docs/apis/_application-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Update astro/src/content/docs/apis/_import-users-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Retain some tie to the other identity types * Update astro/src/content/docs/apis/_import-users-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Update astro/src/content/docs/apis/_import-users-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * Linter * Update astro/src/content/docs/apis/_application-request-body.mdx Co-authored-by: Brent Halsey <[email protected]> * PR feedback - remove unused Aside * PR feedback - remove unused Aside * Update astro/src/content/docs/apis/_tenant-request-body.mdx Co-authored-by: Andy Pai <[email protected]> * PR feedback - password is truly optional (previous password toggle removal did not go far enough in cutting out text) * Update astro/src/content/docs/apis/_user-request-body.mdx Co-authored-by: Maurice Sharp <[email protected]> * PR feedback - password toggle remnants * update screenshots with better nav colors (#3866) * update screenshots with better nav colors * cropping * Version change --------- Co-authored-by: Brent Halsey <[email protected]> Co-authored-by: Spencer Witt <[email protected]> Co-authored-by: Andy Pai <[email protected]> Co-authored-by: Spencer Witt <[email protected]> Co-authored-by: Brent Halsey <[email protected]> Co-authored-by: Andy Pai <[email protected]> Co-authored-by: Maurice Sharp <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.