am_sso_invalidate_token()

Invalidates or destroys the session on OpenSSO Enterprise associated with the single sign-on token handle.

Details

am_sso_invalidate_token() does not free the sso_token_handle parameter. You must call am_sso_destroy_sso_token_handle() to free the memory for the handle itself.

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 parameter:

sso_token_handle

Pointer to a am_sso_token_handle_t type.

---

Note –

If successful, the single sign-on token handle will have an invalid state after this call.

---

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If session was successfully invalidated.

AM_INVALID_ARGUMENT

If the sso_token_handle parameter is NULL.

AM_SERVICE_NOT_INITIALIZED

If the Session Service was not initialized with am_sso_init().

AM_SERVICE_NOT_AVAILABLE

If server returned service not available.

AM_HTTP_ERROR

If an HTTP error was encountered while communicating with OpenSSO Enterprise.

AM_ERROR_PARSING_XML

If an error occurred while parsing XML from OpenSSO Enterprise.

AM_ACCESS_DENIED

If access was denied while communicating with OpenSSO Enterprise.

AM_FAILURE

If any other error occurred.