Skip to content

Commit 4cda30a

Browse files
committed
Clarify authentication flows in wallet API docs (#7899)
Updated the documentation to distinguish between two-step authentication for email, phone, passkey, and SIWE, and single-step flows for guest, custom, and social authentication. Added details and endpoint references for each flow to improve clarity for API users. <!-- start pr-codex --> --- ## PR-Codex overview This PR updates the documentation for the authentication process in the `wallets` page, clarifying the steps for different authentication methods and introducing a new section on social authentication. ### Detailed summary - Clarified the two-step authentication process for email, phone, passkey, or SIWE. - Added information on skipping the first step for guest or custom authentication. - Updated the description for initiating authentication to specify SIWE. - Introduced a new section on social authentication, detailing a single-step flow. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified API Authentication flows: two-step for email, phone, passkey, or SIWE; skip-first-step option for guest or custom auth. * Updated headings and examples to reflect the revised two-step flow (initiate to get a challenge, then complete). * Added a Social Authentication section describing a single-step OAuth flow via a dedicated endpoint, with links to provider details and code samples. * Reorganized content so Get Wallet Information follows the updated authentication flows for better readability. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 98fab93 commit 4cda30a

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

apps/portal/src/app/wallets/page.mdx

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,14 @@ Create wallets for your users with flexible authentication options. Choose from
7272

7373
## API Authentication
7474

75-
Authenticating a user is done in two steps:
75+
For email, phone, passkey, or SIWE authentication, a two-step process is used:
76+
- Initiate authentication to get a challenge
77+
- Complete authentication with the challenge response
7678

77-
1. Initiate authentication
78-
2. Complete authentication
79+
For guest or custom (jwt/auth-payload) authentication, you can skip the first step and directly use the `/v1/auth/complete` endpoint with the required parameters.
7980

8081
### Initiate Authentication
81-
Start authentication with email, phone, passkey, or social providers
82+
Start authentication with email, phone, passkey, or SIWE
8283

8384
<OpenApiEndpoint path="/v1/auth/initiate" method="POST" />
8485

@@ -87,6 +88,15 @@ Verify and complete the authentication process:
8788

8889
<OpenApiEndpoint path="/v1/auth/complete" method="POST" />
8990

91+
## Social Authentication
92+
93+
### Single Step Flow
94+
OAuth is done in a single step using a dedicated endpoint.
95+
96+
Visit the API reference for more details on the available social providers and code snippets.
97+
98+
<OpenApiEndpoint path="/v1/auth/social" method="GET" />
99+
90100
### Get Wallet Information
91101
Retrieve authenticated user's wallet details:
92102

0 commit comments

Comments
 (0)