Skip to Content
Sun and Oracle
Channel Sun
How to Buy
Log In
English
docs.sun.com Home
>
Sun OpenSSO Enterprise 8.0
> Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers
Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers
Search only this book
Search Help
Contained Within
Sun OpenSSO Enterprise 8.0
Find More Documentation
Browse Documentation Titles
Browse Product Documentation
Featured Support Resources
Sun Training Courses
BigAdmin System Admininstration Portal
Sun Support Center
Sun Solve
Download this book in PDF (1531 KB)
Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers
Index
Numbers and Symbols
A
B
C
D
F
H
I
L
M
N
O
P
R
S
T
W
Book Information
Preface
Who Should Use This Book
Related Documentation
OpenSSO Enterprise 8.0 Core Documentation
Related Product Documentation
Searching Sun Product Documentation
Documentation, Support, and Training
Third-Party Web Site References
Sun Welcomes Your Comments
Typographical Conventions
1. The C SDK Application Programming Interfaces
Where is the C SDK?
What is Included in the C SDK?
Header Files
Code Samples
Developing Web Policy Agents
Required C Libraries
Solaris Operating System
Linux Application Environment
Microsoft Windows
2. Authentication Data Types and Functions
The Authentication API for C
Authentication Call Sequence
Authentication Properties
Authentication Data Types
am_auth_context_t
Syntax
Members
Memory Concerns
am_auth_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_locale_t
Details
Syntax
Members
Authentication Callback Data Types
am_auth_choice_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_confirmation_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_language_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_name_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_password_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_text_input_callback_t
Details
Syntax
Members
Memory Concerns
am_auth_text_output_callback_t
Details
Syntax
Members
Memory Concerns
Authentication Functions
am_auth_abort()
Syntax
Parameters
Returns
am_auth_create_auth_context()
Syntax
Parameters
Returns
am_auth_destroy_auth_context()
Syntax
Parameters
Returns
am_auth_get_callback()
Syntax
Parameters
Returns
am_auth_get_module_instance_names()
Details
Syntax
Parameters
Returns
Memory Concerns
am_auth_get_organization_name()
Syntax
Parameters
Returns
am_auth_get_sso_token_id()
Details
Syntax
Parameters
Returns
am_auth_get_status()
Syntax
Parameters
Returns
am_auth_has_more_requirements()
Details
Syntax
Parameters
Returns
am_auth_init()
Syntax
Parameters
Returns
am_auth_login()
Syntax
Parameters
Returns
am_auth_logout()
Syntax
Parameters
Returns
am_auth_num_callbacks()
Syntax
Parameters
Returns
am_auth_submit_requirements()
Syntax
Parameters
Returns
3. Policy Data Types and Functions
The Policy API for C
Resources Strings
Resource Traits
Policy Evaluation
Policy Data Types
am_policy_result_t
Details
Syntax
Members
Memory Concerns
am_policy_t
Syntax
Members
am_resource_traits_t
Syntax
Members
Policy Functions
am_policy_compare_urls()
Syntax
Parameters
Returns
am_policy_destroy()
Details
Syntax
Parameters
Returns
am_policy_evaluate()
Details
Syntax
Parameters
Returns
Memory Concerns
am_policy_evaluate_ignore_url_notenforced()
Details
Syntax
Parameters
Returns
Memory Concerns
am_policy_get_url_resource_root()
Details
Syntax
Parameters
Returns
am_policy_init()
Syntax
Parameters
Returns
Memory Concerns
am_policy_invalidate_session()
Syntax
Parameters
Returns
am_policy_is_notification_enabled()
Syntax
Parameters
Returns
am_policy_notify()
Syntax
Parameters
Returns
am_policy_resource_canonicalize()
Syntax
Parameters
Returns
am_policy_resource_has_patterns()
Syntax
Parameters
Returns
am_policy_result_destroy()
Syntax
Parameters
Returns
am_policy_service_init()
Syntax
Parameters
Returns
4. Single Sign-On Data Types and Functions
The Single Sign-on API for C
Single Sign-on Properties
Single Sign-on Calls
Initialization and Cleanup
Single Sign-on Token Handles
Creating Single Sign-on Token Handles
Validating Single Sign-on Token Handles
Destroying Session Token Handles
Retrieving and Setting Properties
Listening and Notification
Non-Web Applications
Single Sign-on Data Types
am_sso_token_handle_t
Syntax
Members
am_sso_token_listener_func_t
Syntax
Members
Single Sign-on Functions
am_sso_add_listener()
Details
Syntax
Parameters
Returns
am_sso_add_sso_token_listener()
Details
Syntax
Parameters
Returns
am_sso_create_sso_token_handle()
Details
Syntax
Parameters
Returns
am_sso_destroy_sso_token_handle()
Details
Syntax
Parameters
Returns
am_sso_get_auth_level()
Syntax
Parameters
Returns
am_sso_get_auth_type()
Syntax
Parameters
Returns
am_sso_get_host()
Syntax
Parameters
Returns
am_sso_get_idle_time
Syntax
Parameters
Returns
am_sso_get_max_idle_time()
Syntax
Parameters
Returns
am_sso_get_max_session_time()
Syntax
Parameters
Returns
am_sso_get_principal()
Syntax
Returns
am_sso_get_principal_set()
Syntax
Parameters
Returns
am_sso_get_property()
Syntax
Parameters
Returns
am_sso_get_sso_token_id()
Syntax
Parameters
Returns
am_sso_get_time_left()
Syntax
Parameters
Returns
am_sso_init()
Details
Syntax
Parameters
Returns
am_sso_invalidate_token()
Details
Syntax
Parameters
Returns
am_sso_is_valid_token()
Details
Syntax
Parameters
Returns
am_sso_refresh_token()
Details
Syntax
Parameters
Returns
am_sso_remove_listener()
Details
Syntax
Parameters
Returns
am_sso_remove_sso_token_listener()
Details
Syntax
Parameters
Returns
am_sso_set_property()
Details
Syntax
Parameters
Returns
am_sso_validate_token()
Details
Syntax
Parameters
Returns
5. Logging Data Types and Functions
The Logging API for C
Logging Data Types
am_log_record_t
Syntax
Members
am_log_module_id_t
Syntax
Members
Logging Functions
am_log_add_module()
Details
Syntax
Parameters
Returns
am_log_flush_remote_log()
Syntax
Parameters
Returns
am_log_init()
Details
Syntax
Parameters
Returns
am_log_is_level_enabled()
Details
Syntax
Parameters
Returns
am_log_log()
Details
Syntax
Parameters
Returns
am_log_log_record()
Syntax
Parameters
Returns
am_log_record_add_loginfo()
Syntax
Parameters
Returns
am_log_record_create()
Syntax
Parameters
Returns
am_log_record_destroy()
Syntax
Parameters
Returns
am_log_record_populate()
Details
Syntax
Parameters
Returns
am_log_record_set_log_level()
Syntax
Parameters
Returns
am_log_record_set_log_message()
Syntax
Parameters
Returns
am_log_record_set_loginfo_props()
Details
Syntax
Parameters
Returns
am_log_set_levels_from_string()
Details
Syntax
Parameters
Returns
am_log_set_log_file()
Syntax
Parameters
Returns
am_log_set_module_level()
Syntax
Parameters
Returns
am_log_set_remote_info()
Details
Syntax
Parameters
Returns
am_log_vlog()
Details
Syntax
Parameters
Returns
6. Mapping Data Types and Functions
The Mapping API for C
Mapping Data Types
am_map_t
Syntax
Members
Memory Concerns
am_map_entry_iter_t
Syntax
Members
am_map_value_iter_t
Syntax
Members
Mapping Functions
am_map_clear()
Syntax
Parameters
Returns
am_map_copy()
Details
Syntax
Parameters
Returns
Memory Concerns
am_map_create()
Details
Syntax
Parameters
Returns
am_map_destroy()
Syntax
Parameters
Returns
Memory Concerns
am_map_entry_iter_destroy()
Syntax
Parameters
Returns
am_map_entry_iter_get_first_value()
Syntax
Parameters
Returns
Memory Concerns
am_map_entry_iter_get_key()
Syntax
Parameters
Returns
am_map_entry_iter_get_values()
Syntax
Parameters
Returns
Memory Concerns
am_map_entry_iter_is_entry_valid()
Syntax
Parameters
Returns
am_map_entry_iter_next()
Syntax
Parameters
Returns
am_map_erase()
Syntax
Parameters
Returns
am_map_find()
Syntax
Parameters
Returns
Memory Concerns
am_map_find_first_value()
Details
Syntax
Parameters
Returns
am_map_for_each()
Details
Syntax
Parameters
Returns
am_map_get_entries()
Details
Syntax
Parameters
Returns
Memory Concerns
am_map_insert()
Details
Syntax
Parameters
Returns
am_map_size()
Syntax
Parameters
Returns
am_map_value_iter_destroy()
Details
Syntax
Parameters
Returns
am_map_value_iter_get()
Syntax
Parameters
Returns
am_map_value_iter_is_value_valid()
Syntax
Parameters
Returns
am_map_value_iter_next()
Syntax
Parameters
Returns
7. Property Data Types and Functions
The Property API for C
Property Data Types
am_properties_t
Details
Syntax
Members
am_properties_iter_t
Syntax
Members
Property Functions
am_properties_copy()
Details
Syntax
Parameters
Returns
Memory Concerns
am_properties_create()
Syntax
Parameters
Returns
Memory Concerns
am_properties_destroy()
Details
Syntax
Parameters
Returns
am_properties_get()
Details
Syntax
Parameters
Returns
Memory Concerns
am_properties_get_boolean()
Syntax
Parameters
Returns
am_properties_get_boolean_with_default()
Details
Syntax
Parameters
Returns
am_properties_get_entries()
Syntax
Parameters
Returns
am_properties_get_positive_number()
Syntax
Parameters
Returns
am_properties_get_signed()
Syntax
Parameters
Returns
am_properties_get_signed_with_default()
Details
Syntax
Parameters
Returns
am_properties_get_unsigned()
Syntax
Parameters
Returns
am_properties_get_unsigned_with_default()
Details
Syntax
Parameters
Returns
am_properties_get_with_default()
Details
Syntax
Parameters
Returns
Memory Concerns
am_properties_is_set()
Details
Syntax
Parameters
Returns
am_properties_iter_destroy()
Syntax
Parameters
Returns
am_properties_iter_get_key()
Syntax
Parameters
Returns
am_properties_iter_get_value()
Syntax
Parameters
Returns
am_properties_load()
Details
Syntax
Parameters
Returns
am_properties_set()
Details
Syntax
Parameters
Returns
am_properties_store()
Syntax
Parameters
Returns
8. Web Agent Data Types and Functions
Web Agent API for C
Web Agent Data Types
am_web_add_header_in_response_t
Details
Syntax
Members
am_web_free_post_data_t
Details
Syntax
Members
am_web_get_post_data_t
Details
Syntax
Members
am_web_postcache_data_t
Details
Syntax
Members
am_web_render_result_t
Details
Syntax
Members
am_web_request_func_t
Syntax
Members
am_web_request_params_t
Details
Syntax
Members
am_web_set_header_in_request_t
Details
Syntax
Members
am_web_set_method_t
Details
Syntax
Members
am_web_set_user_t
Details
Syntax
Members
post_urls_t
Syntax
Members
Web Agent Function Pointers
am_web_add_header_in_response_func_t
Details
Syntax
Parameters
Returns
am_web_free_post_data_func_t
Details
Syntax
Parameters
Returns
am_web_get_cookie_sync_func_t
Details
Syntax
Parameters
Returns
am_web_get_post_data_func_t
Details
Syntax
Parameters
Returns
am_web_render_result_func_t
Syntax
Parameters
Returns
am_web_result_set_header_func_t
Details
Syntax
Parameters
Returns
am_web_result_set_header_attr_in_request_func_t
Details
Syntax
Parameters
Returns
am_web_result_set_header_attr_in_response_func_t
Details
Syntax
Parameters
Returns
am_web_set_header_in_request_func_t
Details
Syntax
Parameters
Returns
am_web_set_method_func_t
Details
Syntax
Parameters
Returns
am_web_set_user_func_t
Details
Syntax
Parameters
Returns
Web Agent Functions
am_web_init() for Agents 3.0
Syntax
Parameters
Returns
am_agent_init()
Syntax
Parameters
Returns
am_web_build_advice_response()
Syntax
Parameters
Returns
am_web_check_cookie_in_post()
Details
Syntax
Parameters
Returns
am_web_check_cookie_in_query()
Details
Syntax
Parameters
Returns
am_web_clean_post_urls()
Details
Syntax
Parameters
Returns
am_web_cleanup()
Details
Syntax
Parameters
Returns
am_web_clear_attributes_map()
Syntax
Parameters
Returns
am_web_create_post_page()
Syntax
Parameters
Returns
am_web_create_post_preserve_urls()
Details
Syntax
Parameters
Returns
am_web_delete_agent_configuration()
Syntax
Parameters
Returns
am_web_do_cookie_domain_set()
Details
Syntax
Parameters
Returns
am_web_do_cookies_reset()
Details
Syntax
Parameters
Returns
am_web_free_memory()
Syntax
Parameters
Returns
am_web_get_agent_server_host()
Syntax
Parameters
Returns
am_web_get_agent_configuration()
Syntax
Parameters
Returns
am_web_get_agent_server_port()
Syntax
Parameters
Returns
am_web_get_authType()
Details
Syntax
Parameters
Returns
am_web_get_cookie_name()
Syntax
Parameters
Returns
am_web_get_notification_url()
Syntax
Parameters
Returns
am_web_get_parameter_value()
Syntax
Parameters
Returns
Memory Concerns
am_web_get_request_url()
Syntax
Parameters
Returns
am_web_get_token_from_assertion()
Details
Syntax
Parameters
Returns
Memory Concerns
am_web_get_url_to_redirect()
Details
Syntax
Parameters
Returns
am_web_get_user_id_param()
Syntax
Parameters
Returns
am_web_handle_notification()
Details
Syntax
Parameters
Returns
am_web_http_decode()
Syntax
Parameters
Returns
Memory Concerns
am_web_is_access_allowed()
Syntax
Parameters
Returns
am_web_is_cdsso_enabled()
Syntax
Parameters
Returns
am_web_is_cookie_present()
Details
Syntax
Parameters
Returns
am_web_is_debug_on()
Details
Syntax
Parameters
Returns
am_web_is_in_not_enforced_ip_list()
Details
Syntax
Parameters
Returns
am_web_is_in_not_enforced_list()
Details
Syntax
Parameters
Returns
am_web_is_logout_url()
Syntax
Parameters
Returns
am_web_is_max_debug_on()
Syntax
Parameters
Returns
am_web_is_notification()
Syntax
Parameters
Returns
am_web_is_owa_enabled()
Syntax
Parameters
Returns
am_web_is_owa_enabled_change_protocol()
Syntax
Parameters
Returns
am_web_is_owa_enabled_session_timeout_url()
Syntax
Parameters
Returns
am_web_is_postpreserve_enabled()
Syntax
Parameters
Returns
am_web_is_proxy_override_host_port_set()
Details
Syntax
Parameters
Returns
am_web_is_valid_fqdn_url()
Syntax
Parameters
Returns
am_web_log_always()
Syntax
Parameters
Returns
am_web_log_auth()
Syntax
Parameters
Returns
am_web_log_debug()
Syntax
Parameters
Returns
am_web_log_error()
Syntax
Parameters
Returns
am_web_log_info()
Syntax
Parameters
Returns
am_web_log_max_debug()
Syntax
Parameters
Returns
am_web_log_warning()
Syntax
Parameters
Returns
am_web_logout_cookies_reset()
Details
Syntax
Parameters
Returns
am_web_method_num_to_str()
Details
Syntax
Parameters
Returns
am_web_method_str_to_num()
Details
Syntax
Parameters
Returns
am_web_postcache_data_cleanup()
Syntax
Parameters
Returns
am_web_postcache_insert()
Syntax
Parameters
Returns
am_web_postcache_lookup()
Syntax
Parameters
Returns
am_web_postcache_remove()
Syntax
Parameters
Returns
am_web_process_request()
Details
Syntax
Parameters
Returns
am_web_remove_authnrequest()
Details
Syntax
Parameters
Returns
Memory Concerns
am_web_remove_parameter_from_query()
Syntax
Parameters
Returns
Memory Concerns
am_web_result_attr_map_set()
Details
Syntax
Parameters
Returns
Memory Concerns
am_web_result_num_to_str()
Syntax
Parameters
Returns
am_web_set_cookie()
Syntax
Parameters
Returns
9. Additional Data Types and Functions
<am.h>
am_cleanup() Syntax
am_cleanup() Parameters
am_cleanup() Returns
<am_notify.h>
am_notify() Syntax
am_notify() Parameters
am_notify() Returns
<am_string_set.h>
String Data Types
Details
Syntax
Members
String Functions
am_string_set_allocate()
Syntax
Parameters
Returns
am_string_set_destroy()
Syntax
Parameters
Returns
<am_types.h>
boolean_t
bool_t
am_status_t
am_status_to_string()
Syntax
Parameters
Returns
<am_utils.h>
am_http_cookie_encode()
Syntax
Parameters
Returns
am_http_cookie_decode()
Syntax
Parameters
Returns
News Center
About Sun
Contact Sun
Terms of Use
Privacy
Copyright
1994-2009
Sun Microsystems, Inc.
Download this book in PDF (1531 KB)