am_sso_invalidate_token()

Invalidates or destroys the session on the server.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_invalidate_token(const am_sso_token_handle_t sso_token_handle);

Parameters

This function takes the following parameters:

sso_token_handle

SSO token handle of session to be invalidated.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If session was successfully invalidated.

AM_INVALID_ARGUMENT

If the sso_token_handle is invalid.

AM_SERVICE_NOT_INITIALIZED

If the SSO token service was not initialized with am_sso_init().

AM_SERVICE_NOT_AVAILABLE

If server returned service not available.

AM_HTTP_ERROR

If HTTP error encountered while communicating with server.

AM_ERROR_PARSING_XML

If error parsing XML from server.

AM_ACCESS_DENIED

If access denied while communicating with server.

AM_FAILURE

If any other error occurred.

Details

If successful the session handler in input argument will have state invalid after this call.

Note: Does not free the sso_token_handle input parameter. Call am_sso_destroy_sso_token_handle() to free memory for the handle itself.