This repository has been archived on 2021-09-15. You can view files and clone it, but cannot push or open issues or pull requests.
M2OLA/API_Interfaces.txt

28 lines
858 B
Plaintext
Raw Normal View History

2017-01-26 13:58:52 +00:00
#######################
LoginAPI (api/login)
#######################
2017-03-07 06:07:13 +00:00
GET -> Authentication method
2017-01-26 16:30:23 +00:00
Out:
200 -> AUTH_RESULT = "OK" : Authentication sucessful
401 -> AUTH_RESULT = "AUTHENTICATION_FAILURE" : Wrong login/password
403 -> AUTH_RESULT = "NOT_ALLOWED" : User is not allowed for this application
201 -> AUTH_RESULT = "ALREADY_LOGGED" : A user is already logged on this session
2017-01-26 13:58:52 +00:00
DELETE -> Logout current user
2017-01-26 16:30:23 +00:00
Out:
200 -> AUTH_RESULT = "OK" : Logout sucessful
#######################
UserInfoAPI (api/userInfo)
#######################
GET -> Get the current logged user, return None if no one is connected
Out:
2017-01-27 11:05:02 +00:00
200 -> USER = <USER_OBJECT>|None : Dictionary containing user infos or None
2017-01-26 13:58:52 +00:00
2017-03-07 06:07:13 +00:00
########################
Redirect to cas auth (/login)
########################
Redirect to cas auth