am_sso_get_property()

Retrieves the value of a property associated with the specified single sign-on token handle.

Syntax

#include "am_sso.h"
AM_EXPORT const char *
am_sso_get_property(const am_sso_token_handle_t sso_token,
                    const char *property_key, 
                    boolean_t check_if_session_valid);

Parameters

This function takes the following parameters:

sso_token

Pointer to a am_sso_token_handle_t type.

property_key

Pointer to the name of the desired property.

check_if_session_valid

Takes a value based on the boolean_t (defined in the <am_types.h> header file) that specifies if the function should check first if the session is valid. If the session is invalid, NULL will always be returned.

Returns

This function returns a pointer to the value of the property, or NULL if the property is not set or does not have a value.