am_sso_validate_token()

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

Details

This call will go to OpenSSO Enterprise to retrieve the latest session information. The sso_token_handle is updated if the return status is either AM_SUCCESS or AM_INVALID_SESSION. This is different from am_sso_refresh_token()in that it does not update the last access time on the server.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_validate_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 single sign-on token is valid. The information is updated.

AM_INVALID_SESSION

If the session is invalid. The information is updated.

AM_INVALID_ARGUMENT

If the input parameter is invalid.

AM_SERVICE_NOT_INITIALIZED

If Session Service is not initialized.

AM_SERVICE_NOT_AVAILABLE

If OpenSSO Enterprise returned service not available.

AM_HTTP_ERROR

If HTTP error encountered while communicating with OpenSSO Enterprise.

AM_ERROR_PARSING_XML

If error parsing XML from OpenSSO Enterprise.

AM_ACCESS_DENIED

If access is denied while communicating with OpenSSO Enterprise.

AM_FAILURE

If any other error occurred.