am_sso_refresh_token()

Refreshes the session information in the SSOToken associated with the specified single sign-on token handle.

Details

am_sso_refresh_token() goes to Access Manager to retrieve the latest session information with which to update the SSOToken. This is similar in functionality to am_sso_validate_token() however, am_sso_refresh_token() also refreshes the last access time of the session.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_refresh_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.

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 token was refreshed with no errors.

AM_INVALID_ARGUMENT

If the sso_token_handle parameter is invalid.

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 Access Manager.

AM_ERROR_PARSING_XML

If an error occurred while parsing XML from Access Manager.

AM_ACCESS_DENIED

If access was denied while communicating with Access Manager.

AM_SESSION_FAILURE

If the session validation failed.

AM_FAILURE

If any other error occurred.