Skip to content

Commit

Permalink
Add all endpoints to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dcrammer777 committed Nov 15, 2023
1 parent c0f6910 commit bf328bd
Showing 1 changed file with 83 additions and 4 deletions.
87 changes: 83 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Register a new user.
"sendEmail": true, // optional, defaults to true
"sendSms": true, // optional, defaults to false
"setCookie": false // optional, will set a cookie with the JWT, defaults to false
"sendResetEmail": true // optional, will send a password reset email if password is not provided
}
}
```
Expand All @@ -55,7 +56,7 @@ Sets a cookie with the JWT if `options.setCookie` is true.

---

### POST /auth/unpw
### POST /login

Authenticates a user via username/password and returns a JWT.

Expand All @@ -77,7 +78,19 @@ Sets a cookie with the JWT if `options.setCookie` is true.

---

### GET /auth/{provider}
### POST /password/forgot

---

### GET /password/reset/:token

---

### POST /password/reset/:token

---

### GET /oauth/:provider

Authenticates a user via an OAuth provider

Expand All @@ -87,7 +100,7 @@ _None_

---

### Get /auth/{provider}/callback
### Get /oauth/:provider/callback

Callback for OAuth provider

Expand All @@ -97,7 +110,23 @@ _This endpoint is not meant to be called directly_

---

### GET /logout
### POST /oauth/link

---

### POST /login/magic

---

### GET /login/magic/:token

---

### GET /token/refresh

---

### GET /token/revoke

Logs out the user and clears the JWT cookie. Also revokes the refresh token.

Expand All @@ -108,3 +137,53 @@ _None_
#### Response

**200** Clears the JWT cookie.

###

---

### POST /mfa/setup

---

### POST /mfa/verify

---

### POST /mfa/remove

---

### POST /otp/send

---

### POST /otp/verify

---

### POST /otp/remove

---

### POST /authenticator/setup

---

### POST /authenticator/verify

---

### GET /user

---

### GET /user/:user_id

---

### POST /user

---

### PUT /user/:user_id

0 comments on commit bf328bd

Please sign in to comment.