stack icon indicating copy to clipboard operation
stack copied to clipboard

Improve 2FA Implementation and Documentation in Stack Auth API

Open tanxeel opened this issue 1 year ago • 1 comments

Description: The current 2FA implementation in the Stack Auth API is challenging to integrate due to its lack of clarity and usability. Currently, the feature is primarily exposed in the pre-built UI: Account Settings Component

For a fully customizable 2FA integration, it seems necessary to rely on the endpoints, but the documentation provided is insufficient: 2FA Endpoint Documentation

Key issues:

  • Limited documentation on implementing a custom 2FA workflow.
  • No code examples or clear implementation guidelines for using the 2FA API endpoint.
  • Switching to Stack Auth from other solutions like Clerk has been difficult due to the lack of support for customized 2FA.

Expected Behavior

  • Comprehensive documentation with clear examples for integrating 2FA using API endpoints.
  • Support for a fully customizable 2FA workflow independent of the pre-built UI.

Suggested Improvements:

  • Enhance the 2FA API documentation with examples and use cases.
  • Provide guidelines for implementing a customizable 2FA workflow.
  • Expand the feature set beyond the pre-built UI to better support developers seeking flexibility.

Additional Information

This issue affects developers who require a tailored 2FA implementation for their applications. Addressing these concerns would significantly improve the adoption and usability of Stack Auth's API.

Thank you for your consideration!

tanxeel avatar Jan 06 '25 19:01 tanxeel

Additionally can I recommend that you rename OTP to Magic Link (or Visa Versa). I found sometimes it's called Magic Link and sometimes it's called OTP in the interface. It would be good to be consistent.

hongkongkiwi avatar Mar 26 '25 19:03 hongkongkiwi