-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
36296aa
commit 4d61383
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} | ||
``` |