am_sso_create_sso_token_handle()

Creates a handle to session information.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_create_sso_token_handle(am_sso_token_handle_t *sso_token_handle_ptr,
                                   const char *sso_token_id,
                                  boolean_t reset_idle_timer);

Parameters

This function takes the following parameters:

sso_token_handle

Pointer to SSO token handle which will be assigned an handle if the session validation is successful.

sso_token_id

String representation session identifier.

reset_idle_timer

When querying for session information.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS

If session validation was successful and a handle was successfully created.

AM_SERVICE_NOT_INITIALIZED

If SSO token service was not initialized. SSO token service must be initialized by calling am_sso_init() any call to am_sso_* can be made.

AM_INVALID_ARGUMENT

If the session_token_handle_ptr parameter is NULL.

AM_NO_MEMORY

If there was a memory allocation problem.

AM_FAILURE

If any other error occurred.