메소드 |
설명 |
|
__construct ( ) |
Instanciation + config aquisition |
|
authenticate ( SS_HTTPRequest $request ) : true | RESTfulAPI_Error |
Checks if a request to the API is authenticated
Gets API Token from HTTP Request and return Auth result |
|
getOwner ( SS_HTTPRequest $request ) : null | DataObject |
Returns the DataObject related to the token
that sent the authenticated request |
|
getToken ( integer $id ) : string |
Return the stored API token for a specific owner |
|
login ( SS_HTTPRequest $request ) : array |
Login a user into the Framework and generates API token
Only works if the token owner is a Member |
|
logout ( SS_HTTPRequest $request ) |
Logout a user from framework
and update token with an expired one
if token owner class is a Member |
|
lostPassword ( SS_HTTPRequest $request ) : array |
Sends password recovery email |
|
resetToken ( integer $id, boolean $expired = false ) |
Reset an owner's token
if $expired is set to true the owner's will have a new invalidated/expired token |
|