Skip to content

Commit 8bea8bf

Browse files
authored
docs: update verify and generate_link endpoint type options in README (#2373)
Added missing verification type options to the API documentation: - POST /verify: add magiclink, email_change, sms, phone_change types - GET /verify: add email_change type - POST /admin/generate_link: add email_change_current, email_change_new types All type options verified against actual source code in verify.go, mail.go, and mailer.go. Closes #1710 ## What kind of change does this PR introduce? Bug fix, feature, docs update, ...
1 parent 07ff29c commit 8bea8bf

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -965,7 +965,7 @@ headers:
965965

966966
body:
967967
{
968-
"type": "signup" or "magiclink" or "recovery" or "invite",
968+
"type": "signup" or "magiclink" or "recovery" or "invite" or "email_change_current" or "email_change_new",
969969
"email": "[email protected]",
970970
"password": "secret", // only if type = signup
971971
"data": {
@@ -1106,7 +1106,7 @@ Returns:
11061106

11071107
### **POST /verify**
11081108

1109-
Verify a registration or a password recovery. Type can be `signup` or `recovery` or `invite`
1109+
Verify a registration or a password recovery. Type can be `signup`, `recovery`, `invite`, `magiclink`, `email_change`, `sms`, or `phone_change`
11101110
and the `token` is a token returned from either `/signup` or `/recover`.
11111111

11121112
```json
@@ -1126,7 +1126,7 @@ Returns:
11261126
"token_type": "bearer",
11271127
"expires_in": 3600,
11281128
"refresh_token": "a-refresh-token",
1129-
"type": "signup | recovery | invite"
1129+
"type": "signup | recovery | invite | magiclink | email_change | sms | phone_change"
11301130
}
11311131
```
11321132

@@ -1154,7 +1154,7 @@ Returns:
11541154

11551155
### **GET /verify**
11561156

1157-
Verify a registration or a password recovery. Type can be `signup` or `recovery` or `magiclink` or `invite`
1157+
Verify a registration or a password recovery. Type can be `signup`, `recovery`, `magiclink`, `invite`, or `email_change`
11581158
and the `token` is a token returned from either `/signup` or `/recover` or `/magiclink`.
11591159

11601160
query params:

0 commit comments

Comments
 (0)