From eaef75783d3ff46021c5b853555a04ef9dcd7eeb Mon Sep 17 00:00:00 2001 From: Arlo Date: Fri, 22 Mar 2024 23:52:59 +0000 Subject: [PATCH] Add login --- login.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 login.md diff --git a/login.md b/login.md new file mode 100644 index 0000000..e05979c --- /dev/null +++ b/login.md @@ -0,0 +1,28 @@ +# Login + +Authenticates a user and returns their user ID along with a secret key. +Endpoint + +## GET `/api/login//` + +## Parameters + +| Parameter | Type | Description | +| - | - | - | +| username | String |Username of the user | +| password | String |Password of the user | + +## Example Request + +```bash +curl -X GET "https://example.com/api/login/example_user/example_password" +``` + +## Example Response + +```json +{ + "user_id": 123, + "secret": "random_secret_key" +} +``` \ No newline at end of file