Difference between revisions of "M4 API user logout"
From Kolmisoft Wiki
Jump to navigationJump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Description= | =Description= | ||
Logs out a user from the system | |||
<br><br> | <br><br> | ||
=Usage= | =Usage= | ||
* For Backwards-compatibility old name 'logout' is also usable. Call: '''/api/logout''' | * For Backwards-compatibility old name 'logout' is also usable. Call: '''/api/logout''' | ||
* Methods: POST, GET(if allowed, not | * Methods: POST, GET(if allowed, not recommended) | ||
<br><br> | <br><br> | ||
===Parametres=== | ===Parametres=== | ||
| Line 19: | Line 19: | ||
===Result=== | ===Result=== | ||
'''Success''' if User is logged out from the system. | '''Success''' if the User is logged out from the system. | ||
<?xml version="1.0" encoding="utf-8" standalone="yes"?> | <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| Line 28: | Line 28: | ||
---- | ---- | ||
'''Error'''.This means that wrong username and/or password and user can't be authenticated and logged out from the system. | '''Error'''.This means that the wrong username and/or password and the user can't be authenticated and logged out from the system. | ||
<?xml version="1.0" encoding="utf-8" standalone="yes"?> | <?xml version="1.0" encoding="utf-8" standalone="yes"?> | ||
| Line 39: | Line 39: | ||
=See also= | =See also= | ||
* [[ | * [[M4 API]] | ||
Latest revision as of 11:18, 28 November 2022
Description
Logs out a user from the system
Usage
- For Backwards-compatibility old name 'logout' is also usable. Call: /api/logout
- Methods: POST, GET(if allowed, not recommended)
Parametres
- u – username. Required.
- hash - SHA1 hash constructed using just one parameter - API_Secret_Key ( More described in Constructing hash). Required.
Request
HTML POST: http://<SERVER_IP>/billing/api/user_logout?u=username&hash=f7c3bc1d808e04732adf679965ccc34ca7ae3441
Result
Success if the User is logged out from the system.
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <action> <name>logout</name> <status>ok</status> </action>
Error.This means that the wrong username and/or password and the user can't be authenticated and logged out from the system.
<?xml version="1.0" encoding="utf-8" standalone="yes"?> <action> <name>logout</name> <status>failed</status> </action>
