logout

POST public/logout

Ends your API session. After you sign out, calls that use the old session cookie return INVALID_LOGIN.

Request syntax

curl https://apiv2.acumera.net/public/logout \
  --cookie av_session.txt

Request parameters

This function takes no parameters of its own. Send the session cookie you got from login.

Response syntax

{
    "success": "string",
    "returnCode": "string",
    "returnMessage": "string"
}

Response parameters

Field Description
success "1" if you're signed out.
returnCode LOGOUT_SUCCESSFUL when you're signed out.
returnMessage A description of the result.

Errors

If the call fails, success is "0", and returnCode and returnMessage describe the problem. The HTTP status is still 200.

Return code Message Cause
USER_NOT_LOGGED_IN You are not currently logged in. There's no session to end.
INVALID_LOGIN We were unable to log you in. Make sure you entered the correct username, password and 2FA code. You haven't signed in, or your session has already ended.

Examples

curl https://apiv2.acumera.net/public/logout \
  --cookie av_session.txt

Response:

{
    "success": "1",
    "returnCode": "LOGOUT_SUCCESSFUL",
    "returnMessage": "You have been successfully logged out."
}

After you sign out, delete the cookie file:

rm av_session.txt