LSCS Central Auth API

The official Authentication Microservice of La Salle Computer Society (LSCS)

This is an auth microservice, meant to be used by an application backend.

Treat this as a service that simply returns a JSON payload, used only for authenticating LSCS Members and returning necessary data from them.

Usage

Important

NOTE: only RND members can request an API key (associated with their DLSU email) - to prevent unauthorized access

--> All endpoints now requires an API key (in the Authorization request headers)

Auth Endpoints

• [UPDATE 20250107-04:49AM]: no longer needs to login to Google

POST /request-key

• requires email in the request body

• request:

curl -X POST http://localhost:42069/member \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

• response:

{
    "api_key": "somethingsomethingstringssdgasdfkgjdsf",
    "email": "[email protected]"
}

POST /revoke-key

• for revoking/deleting key

• requires email and pepper in the request body

• request:

curl -X POST http://localhost:42069/request-key \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "pepper": "<CONTACT_ADMIN_DEVELOPER_TO_REVOKE_KEY>"}'

• response:

API key for <email> is successfully revoked

Member Endpoints

• all routes: requires Authorization: Bearer <API-KEY> in the request headers

GET /members

• returns all LSCS members from database (yes)

• requires Authorization: Bearer <API-KEY> in the request headers

• request:

curl -X GET http://localhost:42069/member \
  -H "Authorization: Bearer <API-KEY>"

• response:

[
   {
     "id": 12312312,
     "full_name": "Hehe E. Hihi",
     "nickname": "Huhi",
     "email": "[email protected]",
     "telegram": "",
     "position_id": "MEM",
     "committee_id": "MEM",
     "college": "CCS",
     "program": "BS-Org",
     "discord": ""
   },
   {
     "id": 11111110,
     "full_name": "Peter Parker",
     "nickname": "Peter",
     "email": "[email protected]",
     "telegram": "@something",
     "position_id": "MEM",
     "committee_id": "MEM",
     "college": "CLA",
     "program": "POM-LGL",
     "discord": ""
   }
]

POST /member

• returns email, full_name, committee_name, position_name, and division_name of the LSCS member

• requires Authorization: Bearer <API-KEY> in the request headers

• requires email in the request body

• request:

curl -X POST http://localhost:42069/member \
  -H "Authorization: Bearer <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

• response:

{ // success
  "committee_name": "Research and Development",
  "division_name": "Internals",
  "email": "[email protected]",
  "full_name": "Edwin Sadiarin Jr.",
  "position_name": "Committee Trainee"
}

{ // fail
  "error": "Email is not an LSCS member"
}

POST /check-email

• checks if the email exists in database (indicating if it is an LSCS member or not)

• requires Authorization: Bearer <API-KEY> in the request headers

• requires email in the request body

• request:

curl -X POST http://localhost:42069/check-email \
  -H "Authorization: Bearer <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

• response:

{ // success
  "email": "[email protected]",
  "state": "present",
  "success": "Email is an LSCS member"
}

{ // fail
  "email": "[email protected]",
  "error": "Not an LSCS member",
  "state": "absent"
}

POST /check-id

• checks if the provided id exists in database (indicating if it is an LSCS member or not)
• requires Authorization: Bearer <API-KEY> in the request headers
• requires id in the request body

Important

MAKE SURE to send the id as an int (in the request body)

• request:

curl -X POST http://localhost:42069/check-id \
  -H "Authorization: Bearer <API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{"id": 12323004}'

• response:

{ // success
    "id": 12323004,
    "state": "present",
    "success": "ID is an LSCS member"
}

{ // fail
    "id": 1231434214,
    "state": "absent"
    "error": "Not an LSCS member",
}