am_sso_destroy_sso_token_handle()

Destroys the specified single sign-on token handle.

Details

am_sso_destroy_sso_token_handle() does not log out the user or invalidate the session. For more information, see Single Sign-on Token Handles.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_destroy_sso_token_handle(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 which will be destroyed.

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 the memory release process was successful.

AM_INVALID_ARGUMENT

If the sso_token_handle parameter is NULL.

AM_FAILURE

If any other error occurred.