am_sso_create_sso_token_handle()

Creates a single sign-on token handle as a container for a valid SSOTokenID.

Details

For more information, see Single Sign-on Token Handles.

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 a am_sso_token_handle_t type which will be assigned if the session validation is successful.

sso_token_id

Pointer to the SSOTokenID to which the handle will be associated.

reset_idle_timer

Takes one of the values based on the boolean_t (defined in the <am_types.h> header file) that specifies that the idle time of the SSOTokenID on the server will be refreshed when querying for session information.

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 session validation was successful and a single sign-on token handle was successfully created.

AM_SERVICE_NOT_INITIALIZED

If the Session Service was not initialized.

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.