README
¶
User API Documentation
/*
Relative API Path:
api/user/auth
Request:
{
"user": string,
"pass": string,
}
Response(204, 400, 401, 405, 500):
N/A
*/
func Auth(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/user/register
Request:
{
"user": string,
"pass": string,
}
Response (204, 400, 405, 500):
N/A
*/
func Register(res http.ResponseWriter, req *http.Request) bool {}
/*
Relative API Path:
api/user/logout
Request:
N/A
Response (204, 405, 500):
N/A
*/
func Logout(res http.ResponseWriter, req *http.Request) bool {}
Documentation
¶
Overview ¶
Package user is a child of package api to handle api calls concerning users
Package user is a child of package api to handle api calls concerning users ¶
Package user is a child of package api to handle api calls concerning users ¶
Package user is a child of package api to handle api calls concerning users
Index ¶
- func Auth(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
- func Delete(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
- func GetSecret(user string, directory string) (string, error)
- func List(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
- func Logout(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
- func Register(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
- func UpdatePassword(res http.ResponseWriter, req *http.Request, logger *log.Logger, dir string) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Auth ¶
Auth function is accessed by an API call from the webhost root by accessing /user_auth and sending it a post request with userRequestData struct in JSON format.
func GetSecret ¶
GetSecret is not accessible from the any client side request. It is only used on the server side to help verify users are who they say they are.
func Logout ¶
Logout function is accessed by an API call from the webhost root by accessing /user_logout and sending it an empty POST request. This function will delete the user-auth cookie session store
func Register ¶
Register function is accessed by an API call from the webhost root by accessing /user_register and sending it a post request with userRequestData struct in JSON format.
func UpdatePassword ¶
Types ¶
This section is empty.
Source Files