Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dcrammer777 committed Nov 15, 2023
1 parent 36296aa commit 4d61383
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# service-authentication

This is a service that provides authentication for the other services in the system.

### Features:

- Registration
- Login
- Password Reset
- Webhooks
- JWTs
- Token Refresh
- oAuth
- Configurable token providers
- Linking oAuth to user profile
- MFA
- SMS-based, OTPs
- Authenticator apps
- Rate limiting
- CAPTCHA
- Audit trail
- Roles and caps

---

## Reference

## Endpoints

### POST /register

Register a new user.

#### Request

```json
{
"email": "example@gmail.com", // required
"password": "password123" // optional, if not provided, a random password will be generated
}
```

0 comments on commit 4d61383

Please sign in to comment.