am_sso_validate_token()

Validates an SSO token.

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

sso_token_handle

SSO token to validate.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If SSO token is valid, session handle is updated.

AM_INVALID_SESSION

If the session is invalid, session handle is updated.

AM_INVALID_ARGUMENT

If the input parameter is invalid.

AM_SERVICE_NOT_INITIALIZED

If SSO token service is not initialized. SSO token service must be initialized by calling am_sso_init() before any call to am_sso.

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

This call will go to the server to get the latest session info and update the sso_token_handle input parameter. The sso_token_handle input parameter 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.