User API Doc¶

IdentityServicesEngineAPI¶

The IdentityServicesEngineAPI class creates “connection objects” for working with the Identity Services Engine APIs and hierarchically organizes the Identity Services Engine APIs and their endpoints underneath these connection objects.

IdentityServicesEngineAPI summary structure¶

v3.0.0 summary¶

`IdentityServicesEngineAPI`	aci_bindings	`get_aci_bindings()` `get_aci_bindings_generator()` `get_version()`
	aci_settings	`get_aci_settings()` `get_version()` `test_aci_connectivity()` `update_aci_settings_by_id()`
	active_directory	`create_active_directory()` `delete_active_directory_by_id()` `get_active_directory()` `get_active_directory_by_id()` `get_active_directory_by_name()` `get_active_directory_generator()` `get_groups_by_domain()` `get_trusted_domains()` `get_user_groups()` `get_version()` `is_user_member_of_groups()` `join_domain()` `join_domain_with_all_nodes()` `leave_domain()` `leave_domain_with_all_nodes()` `load_groups_from_domain()`
	admin_user	`get_admin_user_by_id()` `get_admin_users()` `get_admin_users_generator()` `get_version()`
	allowed_protocols	`create_allowed_protocol()` `delete_allowed_protocol_by_id()` `get_allowed_protocol_by_id()` `get_allowed_protocol_by_name()` `get_allowed_protocols()` `get_allowed_protocols_generator()` `get_version()` `update_allowed_protocol_by_id()`
	anc_endpoint	`apply_anc_endpoint()` `bulk_request_for_anc_endpoint()` `clear_anc_endpoint()` `get_anc_endpoint()` `get_anc_endpoint_by_id()` `get_anc_endpoint_generator()` `get_version()` `monitor_bulk_status_anc_endpoint()`
	anc_policy	`bulk_request_for_anc_policy()` `create_anc_policy()` `delete_anc_policy_by_id()` `get_anc_policy()` `get_anc_policy_by_id()` `get_anc_policy_by_name()` `get_anc_policy_generator()` `get_version()` `monitor_bulk_status_anc_policy()` `update_anc_policy_by_id()`
	authentication	`authentication_api()`
	authorization_profile	`create_authorization_profile()` `delete_authorization_profile_by_id()` `get_authorization_profile_by_id()` `get_authorization_profile_by_name()` `get_authorization_profiles()` `get_authorization_profiles_generator()` `get_version()` `update_authorization_profile_by_id()`
	backup_and_restore	`cancel_backup()` `config_backup()` `create_scheduled_config_backup()` `get_last_config_backup_status()` `restore_config_backup()` `update_scheduled_config_backup()`
	byod_portal	`create_byod_portal()` `delete_byod_portal_by_id()` `get_byod_portal()` `get_byod_portal_by_id()` `get_byod_portal_generator()` `get_version()` `update_byod_portal_by_id()`
	certificate_profile	`create_certificate_profile()` `get_certificate_profile()` `get_certificate_profile_by_id()` `get_certificate_profile_by_name()` `get_certificate_profile_generator()` `get_version()` `update_certificate_profile_by_id()`
	certificate_template	`get_certificate_template()` `get_certificate_template_by_id()` `get_certificate_template_by_name()` `get_certificate_template_generator()` `get_version()`
	certificates	`bind_csr()` `delete_csr_by_id()` `delete_system_certificate_by_id()` `delete_trusted_certificate_by_id()` `export_csr()` `export_system_certificate()` `export_trusted_certificate()` `generate_csr()` `generate_intermediate_ca_csr()` `get_csr_by_id()` `get_csrs()` `get_csrs_generator()` `get_system_certificate_by_id()` `get_system_certificates()` `get_system_certificates_generator()` `get_trusted_certificate_by_id()` `get_trusted_certificates()` `get_trusted_certificates_generator()` `import_system_certificate()` `import_trust_certificate()` `regenerate_ise_root_ca()` `renew_certificates()` `update_system_certificate()` `update_trusted_certificate()`
	clear_threats_and_vulnerabilities	`clear_threats_and_vulnerabilities()` `get_version()`
	consumer	`access_secret()` `activate_account()` `create_account()` `lookup_service()`
	custom_caller	`add_api()` `call_api()`
	device_administration_authentication_rules	`create_device_admin_authentication_rule()` `delete_device_admin_authentication_rule_by_id()` `get_device_admin_authentication_rule_by_id()` `get_device_admin_authentication_rules()` `reset_hit_counts_device_admin_authentication_rules()` `update_device_admin_authentication_rule_by_id()`
	device_administration_authorization_exception_rules	`create_device_admin_local_exception_rule()` `delete_device_admin_local_exception_rule_by_id()` `get_device_admin_local_exception_rule_by_id()` `get_device_admin_local_exception_rules()` `reset_hit_counts_device_admin_local_exceptions()` `update_device_admin_local_exception_rule_by_id()`
	device_administration_authorization_global_exception_rules	`create_device_admin_policy_set_global_exception()` `delete_device_admin_policy_set_global_exception_by_rule_id()` `get_device_admin_policy_set_global_exception_by_rule_id()` `get_device_admin_policy_set_global_exception_rules()` `reset_hit_counts_device_admin_global_exceptions()` `update_device_admin_policy_set_global_exception_by_rule_id()`
	device_administration_authorization_rules	`create_device_admin_authorization_rule()` `delete_device_admin_authorization_rule_by_id()` `get_device_admin_authorization_rule_by_id()` `get_device_admin_authorization_rules()` `reset_hit_counts_device_admin_authorization_rules()` `update_device_admin_authorization_rule_by_id()`
	device_administration_command_set	`get_device_admin_command_sets()`
	device_administration_conditions	`create_device_admin_condition()` `delete_device_admin_condition_by_id()` `delete_device_admin_condition_by_name()` `get_device_admin_condition_by_id()` `get_device_admin_condition_by_name()` `get_device_admin_conditions()` `get_device_admin_conditions_for_authentication_rules()` `get_device_admin_conditions_for_authorization_rules()` `get_device_admin_conditions_for_policy_sets()` `update_device_admin_condition_by_id()` `update_device_admin_condition_by_name()`
	device_administration_dictionary_attributes_list	`get_device_admin_dictionaries_authentication()` `get_device_admin_dictionaries_authorization()` `get_device_admin_dictionaries_policy_set()`
	device_administration_identity_stores	`get_device_admin_identity_stores()`
	device_administration_network_conditions	`create_device_admin_network_condition()` `delete_device_admin_network_condition_by_id()` `get_device_admin_network_condition_by_id()` `get_device_admin_network_conditions()` `update_device_admin_network_condition_by_id()`
	device_administration_policy_set	`create_device_admin_policy_set()` `delete_device_admin_policy_set_by_id()` `get_device_admin_policy_set_by_id()` `get_device_admin_policy_sets()` `reset_hit_counts_device_admin_policy_sets()` `update_device_admin_policy_set_by_id()`
	device_administration_profiles	`get_device_admin_profiles()`
	device_administration_service_names	`get_device_admin_service_names()`
	device_administration_time_date_conditions	`create_device_admin_time_condition()` `delete_device_admin_time_condition_by_id()` `get_device_admin_time_condition_by_id()` `get_device_admin_time_conditions()` `update_device_admin_time_condition_by_id()`
	downloadable_acl	`create_downloadable_acl()` `delete_downloadable_acl_by_id()` `get_downloadable_acl()` `get_downloadable_acl_by_id()` `get_downloadable_acl_generator()` `get_version()` `update_downloadable_acl_by_id()`
	egress_matrix_cell	`bulk_request_for_egress_matrix_cell()` `clear_all_matrix_cells()` `clone_matrix_cell()` `create_egress_matrix_cell()` `delete_egress_matrix_cell_by_id()` `get_egress_matrix_cell()` `get_egress_matrix_cell_by_id()` `get_egress_matrix_cell_generator()` `get_version()` `monitor_bulk_status_egress_matrix_cell()` `set_all_cells_status()` `update_egress_matrix_cell_by_id()`
	endpoint	`bulk_request_for_endpoint()` `create_endpoint()` `delete_endpoint_by_id()` `deregister_endpoint()` `get_endpoint_by_id()` `get_endpoint_by_name()` `get_endpoints()` `get_endpoints_generator()` `get_rejected_endpoints()` `get_version()` `monitor_bulk_status_endpoint()` `register_endpoint()` `release_rejected_endpoint()` `update_endpoint_by_id()`
	endpoint_certificate	`create_endpoint_certificate()` `get_version()`
	endpoint_identity_group	`create_endpoint_group()` `delete_endpoint_group_by_id()` `get_endpoint_group_by_id()` `get_endpoint_group_by_name()` `get_endpoint_groups()` `get_endpoint_groups_generator()` `get_version()` `update_endpoint_group_by_id()`
	external_radius_server	`create_external_radius_server()` `delete_external_radius_server_by_id()` `get_external_radius_server()` `get_external_radius_server_by_id()` `get_external_radius_server_by_name()` `get_external_radius_server_generator()` `get_version()` `update_external_radius_server_by_id()`
	filter_policy	`create_filter_policy()` `delete_filter_policy_by_id()` `get_filter_policy()` `get_filter_policy_by_id()` `get_filter_policy_generator()` `get_version()` `update_filter_policy_by_id()`
	guest_location	`get_guest_location()` `get_guest_location_by_id()` `get_guest_location_generator()` `get_version()`
	guest_smtp_notification_configuration	`create_guest_smtp_notification_settings()` `get_guest_smtp_notification_settings()` `get_guest_smtp_notification_settings_by_id()` `get_guest_smtp_notification_settings_generator()` `get_version()` `update_guest_smtp_notification_settings_by_id()`
	guest_ssid	`create_guest_ssid()` `delete_guest_ssid_by_id()` `get_guest_ssid()` `get_guest_ssid_by_id()` `get_guest_ssid_generator()` `get_version()` `update_guest_ssid_by_id()`
	guest_type	`create_guest_type()` `delete_guest_type_by_id()` `get_guest_type()` `get_guest_type_by_id()` `get_guest_type_generator()` `get_version()` `update_guest_type_by_id()` `update_guest_type_email()` `update_guest_type_sms()`
	guest_user	`approve_guest_user_by_id()` `bulk_request_for_guest_user()` `change_sponsor_password()` `create_guest_user()` `delete_guest_user_by_id()` `delete_guest_user_by_name()` `deny_guest_user_by_id()` `get_guest_user_by_id()` `get_guest_user_by_name()` `get_guest_users()` `get_guest_users_generator()` `get_version()` `monitor_bulk_status_guest_user()` `reinstate_guest_user_by_id()` `reinstate_guest_user_by_name()` `reset_guest_user_password_by_id()` `suspend_guest_user_by_id()` `suspend_guest_user_by_name()` `update_guest_user_by_id()` `update_guest_user_by_name()` `update_guest_user_email()` `update_guest_user_sms()`
	hotspot_portal	`create_hotspot_portal()` `delete_hotspot_portal_by_id()` `get_hotspot_portal()` `get_hotspot_portal_by_id()` `get_hotspot_portal_generator()` `get_version()` `update_hotspot_portal_by_id()`
	identity_groups	`create_identity_group()` `get_identity_group_by_id()` `get_identity_group_by_name()` `get_identity_groups()` `get_identity_groups_generator()` `get_version()` `update_identity_group_by_id()`
	identity_sequence	`create_identity_sequence()` `delete_identity_sequence_by_id()` `get_identity_sequence()` `get_identity_sequence_by_id()` `get_identity_sequence_by_name()` `get_identity_sequence_generator()` `get_version()` `update_identity_sequence_by_id()`
	internal_user	`create_internal_user()` `delete_internal_user_by_id()` `delete_internal_user_by_name()` `get_internal_user()` `get_internal_user_by_id()` `get_internal_user_by_name()` `get_internal_user_generator()` `get_version()` `update_internal_user_by_id()` `update_internal_user_by_name()`
	ip_to_sgt_mapping	`bulk_request_for_ip_to_sgt_mapping()` `create_ip_to_sgt_mapping()` `delete_ip_to_sgt_mapping_by_id()` `deploy_all_ip_to_sgt_mapping()` `deploy_ip_to_sgt_mapping_by_id()` `get_deploy_status_ip_to_sgt_mapping()` `get_ip_to_sgt_mapping()` `get_ip_to_sgt_mapping_by_id()` `get_ip_to_sgt_mapping_generator()` `get_version()` `monitor_bulk_status_ip_to_sgt_mapping()` `update_ip_to_sgt_mapping_by_id()`
	ip_to_sgt_mapping_group	`bulk_request_for_ip_to_sgt_mapping_group()` `create_ip_to_sgt_mapping_group()` `delete_ip_to_sgt_mapping_group_by_id()` `deploy_all_ip_to_sgt_mapping_group()` `deploy_ip_to_sgt_mapping_group_by_id()` `get_deploy_status_ip_to_sgt_mapping_group()` `get_ip_to_sgt_mapping_group()` `get_ip_to_sgt_mapping_group_by_id()` `get_ip_to_sgt_mapping_group_generator()` `get_version()` `monitor_bulk_status_ip_to_sgt_mapping_group()` `update_ip_to_sgt_mapping_group_by_id()`
	mdm	`get_endpoint_by_mac_address()` `get_endpoints()` `get_endpoints_by_os_type()` `get_endpoints_by_type()`
	misc	`delete_all_sessions()` `get_account_status_by_mac()` `get_active_count()` `get_active_list()` `get_authentication_status_by_mac()` `get_failure_reasons()` `get_mnt_version()` `get_posture_count()` `get_profiler_count()` `get_session_auth_list()` `get_sessions_by_endpoint_ip()` `get_sessions_by_mac()` `get_sessions_by_nas_ip()` `get_sessions_by_session_id()` `get_sessions_by_username()` `session_disconnect()` `session_reauthentication_by_mac()`
	my_device_portal	`create_my_device_portal()` `delete_my_device_portal_by_id()` `get_my_device_portal()` `get_my_device_portal_by_id()` `get_my_device_portal_generator()` `get_version()` `update_my_device_portal_by_id()`
	native_supplicant_profile	`delete_native_supplicant_profile_by_id()` `get_native_supplicant_profile()` `get_native_supplicant_profile_by_id()` `get_native_supplicant_profile_generator()` `get_version()` `update_native_supplicant_profile_by_id()`
	network_access_authentication_rules	`create_network_access_authentication_rule()` `delete_network_access_authentication_rule_by_id()` `get_network_access_authentication_rule_by_id()` `get_network_access_authentication_rules()` `reset_hit_counts_network_access_authentication_rules()` `update_network_access_authentication_rule_by_id()`
	network_access_authorization_exception_rules	`create_network_access_local_exception_rule()` `delete_network_access_local_exception_rule_by_id()` `get_network_access_local_exception_rule_by_id()` `get_network_access_local_exception_rules()` `reset_hit_counts_network_access_local_exceptions()` `update_network_access_local_exception_rule_by_id()`
	network_access_authorization_global_exception_rules	`create_network_access_policy_set_global_exception_rule()` `delete_network_access_policy_set_global_exception_rule_by_id()` `get_network_access_policy_set_global_exception_rule_by_id()` `get_network_access_policy_set_global_exception_rules()` `reset_hit_counts_network_access_global_exceptions()` `update_network_access_policy_set_global_exception_rule_by_id()`
	network_access_authorization_rules	`create_network_access_authorization_rule()` `delete_network_access_authorization_rule_by_id()` `get_network_access_authorization_rule_by_id()` `get_network_access_authorization_rules()` `reset_hit_counts_network_access_authorization_rules()` `update_network_access_authorization_rule_by_id()`
	network_access_conditions	`create_network_access_condition()` `delete_network_access_condition_by_id()` `delete_network_access_condition_by_name()` `get_network_access_condition_by_id()` `get_network_access_condition_by_name()` `get_network_access_conditions()` `get_network_access_conditions_for_authentication_rules()` `get_network_access_conditions_for_authorization_rules()` `get_network_access_conditions_for_policy_sets()` `update_network_access_condition_by_id()` `update_network_access_condition_by_name()`
	network_access_dictionary	`create_network_access_dictionaries()` `delete_network_access_dictionary_by_name()` `get_network_access_dictionaries()` `get_network_access_dictionary_by_name()` `update_network_access_dictionary_by_name()`
	network_access_dictionary_attribute	`create_network_access_dictionary_attribute()` `delete_network_access_dictionary_attribute_by_name()` `get_network_access_dictionary_attribute_by_name()` `get_network_access_dictionary_attributes_by_dictionary_name()` `update_network_access_dictionary_attribute_by_name()`
	network_access_dictionary_attributes_list	`get_network_access_dictionaries_authentication()` `get_network_access_dictionaries_authorization()` `get_network_access_dictionaries_policy_set()`
	network_access_identity_stores	`get_network_access_identity_stores()`
	network_access_network_conditions	`create_network_access_network_condition()` `delete_network_access_network_condition_by_id()` `get_network_access_network_condition_by_id()` `get_network_access_network_conditions()` `update_network_access_network_condition_by_id()`
	network_access_policy_set	`create_network_access_policy_set()` `delete_network_access_policy_set_by_id()` `get_network_access_policy_set_by_id()` `get_network_access_policy_sets()` `reset_hit_counts_network_access_policy_sets()` `update_network_access_policy_set_by_id()`
	network_access_profiles	`get_network_access_profiles()`
	network_access_security_groups	`get_network_access_security_groups()`
	network_access_service_names	`get_network_access_service_names()`
	network_access_time_date_conditions	`create_network_access_time_condition()` `delete_network_access_time_condition_by_id()` `get_network_access_time_condition_by_id()` `get_network_access_time_conditions()` `update_network_access_time_condition_by_id()`
	network_device	`bulk_request_for_network_device()` `create_network_device()` `delete_network_device_by_id()` `delete_network_device_by_name()` `get_network_device()` `get_network_device_by_id()` `get_network_device_by_name()` `get_network_device_generator()` `get_version()` `monitor_bulk_status_network_device()` `update_network_device_by_id()` `update_network_device_by_name()`
	network_device_group	`create_network_device_group()` `delete_network_device_group_by_id()` `get_network_device_group()` `get_network_device_group_by_id()` `get_network_device_group_by_name()` `get_network_device_group_generator()` `get_version()` `update_network_device_group_by_id()`
	node_deployment	`delete_node()` `get_node_details()` `get_nodes()` `promote_node()` `register_node()` `update_node()`
	node_details	`get_node_detail_by_id()` `get_node_detail_by_name()` `get_node_details()` `get_nodes_generator()` `get_version()`
	node_group	`create_node_group()` `delete_node_group()` `get_node_group()` `get_node_groups()` `update_node_group()`
	pan_ha	`disable_pan_ha()` `enable_pan_ha()` `get_pan_ha_status()`
	portal	`get_portal_by_id()` `get_portals()` `get_portals_generator()` `get_version()`
	portal_global_setting	`get_portal_global_setting_by_id()` `get_portal_global_settings()` `get_portal_global_settings_generator()` `get_version()` `update_portal_global_setting_by_id()`
	portal_theme	`create_portal_theme()` `delete_portal_theme_by_id()` `get_portal_theme_by_id()` `get_portal_themes()` `get_portal_themes_generator()` `get_version()` `update_portal_theme_by_id()`
	profiler	`get_profiles()`
	profiler_profile	`get_profiler_profile_by_id()` `get_profiler_profiles()` `get_profiler_profiles_generator()` `get_version()`
	provider	`authorization()` `register_service()` `reregister_service()` `unregister_service()`
	psn_node_details_with_radius_service	`get_session_service_node()` `get_session_service_node_by_id()` `get_session_service_node_by_name()` `get_session_service_node_generator()` `get_version()`
	pull_deployment_info	`get_deployment_info()` `get_version()`
	px_grid_node	`approve_px_grid_node()` `delete_px_grid_node_by_name()` `get_px_grid_node()` `get_px_grid_node_by_id()` `get_px_grid_node_by_name()` `get_px_grid_node_generator()` `get_version()`
	px_grid_settings	`autoapprove_px_grid_settings()` `get_version()`
	radius_failure	`get_failures()`
	radius_server_sequence	`create_radius_server_sequence()` `delete_radius_server_sequence_by_id()` `get_radius_server_sequence()` `get_radius_server_sequence_by_id()` `get_radius_server_sequence_generator()` `get_version()` `update_radius_server_sequence_by_id()`
	replication_status	`get_node_replication_status()`
	repository	`create_repository()` `delete_repository()` `get_repositories()` `get_repository()` `get_repository_files()` `update_repository()`
	restid_store	`create_rest_id_store()` `delete_rest_id_store_by_id()` `delete_rest_id_store_by_name()` `get_rest_id_store()` `get_rest_id_store_by_id()` `get_rest_id_store_by_name()` `get_rest_id_store_generator()` `get_version()` `update_rest_id_store_by_id()` `update_rest_id_store_by_name()`
	security_group_to_virtual_network	`bulk_request_for_security_groups_to_vn_to_vlan()` `create_security_groups_to_vn_to_vlan()` `delete_security_groups_to_vn_to_vlan_by_id()` `get_security_groups_to_vn_to_vlan()` `get_security_groups_to_vn_to_vlan_by_id()` `get_security_groups_to_vn_to_vlan_generator()` `get_version()` `monitor_bulk_status_security_groups_to_vn_to_vlan()` `update_security_groups_to_vn_to_vlan_by_id()`
	security_groups	`bulk_request_for_security_group()` `create_security_group()` `delete_security_group_by_id()` `get_security_group_by_id()` `get_security_groups()` `get_security_groups_generator()` `get_version()` `monitor_bulk_status_security_group()` `update_security_group_by_id()`
	security_groups_acls	`bulk_request_for_security_groups_acl()` `create_security_groups_acl()` `delete_security_groups_acl_by_id()` `get_security_groups_acl()` `get_security_groups_acl_by_id()` `get_security_groups_acl_generator()` `get_version()` `monitor_bulk_status_security_groups_acl()` `update_security_groups_acl_by_id()`
	self_registered_portal	`create_self_registered_portal()` `delete_self_registered_portal_by_id()` `get_self_registered_portal_by_id()` `get_self_registered_portals()` `get_self_registered_portals_generator()` `get_version()` `update_self_registered_portal_by_id()`
	session_directory	`get_session_by_ip_address()` `get_session_by_mac_address()` `get_sessions()` `get_sessions_for_recovery()` `get_user_group_by_user_name()` `get_user_groups()`
	sms_provider	`get_sms_provider()` `get_sms_provider_generator()` `get_version()`
	sponsor_group	`create_sponsor_group()` `delete_sponsor_group_by_id()` `get_sponsor_group()` `get_sponsor_group_by_id()` `get_sponsor_group_generator()` `get_version()` `update_sponsor_group_by_id()`
	sponsor_group_member	`get_sponsor_group_member()` `get_sponsor_group_member_generator()` `get_version()`
	sponsor_portal	`create_sponsor_portal()` `delete_sponsor_portal_by_id()` `get_sponsor_portal()` `get_sponsor_portal_by_id()` `get_sponsor_portal_generator()` `get_version()` `update_sponsor_portal_by_id()`
	sponsored_guest_portal	`create_sponsored_guest_portal()` `delete_sponsored_guest_portal_by_id()` `get_sponsored_guest_portal_by_id()` `get_sponsored_guest_portals()` `get_sponsored_guest_portals_generator()` `get_version()` `update_sponsored_guest_portal_by_id()`
	support_bundle_download	`download_support_bundle()` `get_version()`
	support_bundle_status	`get_support_bundle_status()` `get_support_bundle_status_by_id()` `get_support_bundle_status_generator()` `get_version()`
	support_bundle_trigger_configuration	`create_support_bundle()` `get_version()`
	sxp_connections	`bulk_request_for_sxp_connections()` `create_sxp_connections()` `delete_sxp_connections_by_id()` `get_sxp_connections()` `get_sxp_connections_by_id()` `get_sxp_connections_generator()` `get_version()` `monitor_bulk_status_sxp_connections()` `update_sxp_connections_by_id()`
	sxp_local_bindings	`bulk_request_for_sxp_local_bindings()` `create_sxp_local_bindings()` `delete_sxp_local_bindings_by_id()` `get_sxp_local_bindings()` `get_sxp_local_bindings_by_id()` `get_sxp_local_bindings_generator()` `get_version()` `monitor_bulk_status_sxp_local_bindings()` `update_sxp_local_bindings_by_id()`
	sxp_vpns	`bulk_request_for_sxp_vpns()` `create_sxp_vpn()` `delete_sxp_vpn_by_id()` `get_sxp_vpn_by_id()` `get_sxp_vpns()` `get_sxp_vpns_generator()` `get_version()` `monitor_bulk_status_sxp_vpns()`
	sync_ise_node	`sync_node()`
	system_certificate	`create_system_certificate()` `get_version()`
	system_health	`get_healths()` `get_performances()`
	tacacs_command_sets	`create_tacacs_command_sets()` `delete_tacacs_command_sets_by_id()` `get_tacacs_command_sets()` `get_tacacs_command_sets_by_id()` `get_tacacs_command_sets_by_name()` `get_tacacs_command_sets_generator()` `get_version()` `update_tacacs_command_sets_by_id()`
	tacacs_external_servers	`create_tacacs_external_servers()` `delete_tacacs_external_servers_by_id()` `get_tacacs_external_servers()` `get_tacacs_external_servers_by_id()` `get_tacacs_external_servers_by_name()` `get_tacacs_external_servers_generator()` `get_version()` `update_tacacs_external_servers_by_id()`
	tacacs_profile	`create_tacacs_profile()` `delete_tacacs_profile_by_id()` `get_tacacs_profile()` `get_tacacs_profile_by_id()` `get_tacacs_profile_by_name()` `get_tacacs_profile_generator()` `get_version()` `update_tacacs_profile_by_id()`
	tacacs_server_sequence	`create_tacacs_server_sequence()` `delete_tacacs_server_sequence_by_id()` `get_tacacs_server_sequence()` `get_tacacs_server_sequence_by_id()` `get_tacacs_server_sequence_by_name()` `get_tacacs_server_sequence_generator()` `get_version()` `update_tacacs_server_sequence_by_id()`
	tasks	`get_task_status()` `get_task_status_by_id()`
	telemetry_information	`get_telemetry_info_by_id()` `get_telemetry_information()` `get_telemetry_information_generator()` `get_version()`
	trust_sec_configuration	`get_egress_matrices()` `get_egress_policies()` `get_security_group_acls()` `get_security_groups()`
	trust_sec_sxp	`get_bindings()`
	version_and_patch	`get_ise_version_and_patch()`
	version_info	`get_version_info()`

IdentityServicesEngineAPI Class¶

class IdentityServicesEngineAPI[source]¶

Identity Services Engine API wrapper.

Creates a ‘session’ for all API calls through a created IdentityServicesEngineAPI object. The ‘session’ handles authentication, provides the needed headers, and checks all responses for error conditions.

IdentityServicesEngineAPI wraps all of the individual Identity Services Engine APIs and represents them in a simple hierarchical structure.

__init__(username=None, password=None, encoded_auth=None, uses_api_gateway=True, base_url='https://dcloud-dna-ise-rtp.cisco.com', ui_base_url=None, ers_base_url=None, mnt_base_url=None, px_grid_base_url=None, single_request_timeout=60, wait_on_rate_limit=True, verify=True, version='3.0.0', debug='False', object_factory=<function mydict_data_factory>, validator=<class 'ciscoisesdk.models.schema_validator.SchemaValidator'>)[source]¶

Create a new IdentityServicesEngineAPI object. An access token is required to interact with the Identity Services Engine APIs. This package supports two methods for you to pass the authorization token:

1. Provide a encoded_auth value (username:password encoded in base 64). This has priority over the following method

Provide username and password values.

This package supports two methods for you to set those values:

1. Provide the parameter. That is the encoded_auth or username and password parameters.

2. If an argument is not supplied, the package checks for its environment variable counterpart. That is the IDENTITY_SERVICES_ENGINE_ENCODED_AUTH, IDENTITY_SERVICES_ENGINE_USERNAME, IDENTITY_SERVICES_ENGINE_PASSWORD.

When not given enough parameters an AccessTokenError is raised.

Parameters

uses_api_gateway (bool,basestring) – Controls whether we use the ISE’s API Gateway to make the request. Defaults to the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY (or IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY_STRING) environment variable or ciscoisesdk.config.DEFAULT_USES_API_GATEWAY if the environment variables are not set.
base_url (basestring) – The base URL to be prefixed to the individual API endpoint suffixes, used when uses_api_gateway is True. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable or ciscoisesdk.config.DEFAULT_BASE_URL if the environment variable is not set.
ui_base_url (basestring) – The UI base URL to be prefixed to the individual ISE UI API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
ers_base_url (basestring) – The ERS base URL to be prefixed to the individual ISE ERS API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
mnt_base_url (basestring) – The MNT base URL to be prefixed to the individual ISE MNT API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
px_grid_base_url (basestring) – The PxGrid base URL to be prefixed to the individual ISE PxGrid API endpoint suffixes, used when uses_api_gateway is False. Defaults to the IDENTITY_SERVICES_ENGINE_BASE_URL environment variable if set.
username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.
single_request_timeout (int) – Timeout (in seconds) for RESTful HTTP requests. Defaults to the IDENTITY_SERVICES_ENGINE_SINGLE_REQUEST_TIMEOUT environment variable or ciscoisesdk.config.DEFAULT_SINGLE_REQUEST_TIMEOUT if the environment variable is not set.
wait_on_rate_limit (bool) – Enables or disables automatic rate-limit handling. Defaults to the IDENTITY_SERVICES_ENGINE_WAIT_ON_RATE_LIMIT environment variable or ciscoisesdk.config.DEFAULT_WAIT_ON_RATE_LIMIT if the environment variable is not set.
verify (bool,basestring) – Controls whether we verify the server’s TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERIFY (or IDENTITY_SERVICES_ENGINE_VERIFY_STRING) environment variable or ciscoisesdk.config.DEFAULT_VERIFY if the environment variables are not set.
version (basestring) – Controls which version of IDENTITY_SERVICES_ENGINE to use. Defaults to the IDENTITY_SERVICES_ENGINE_VERSION environment variable or ciscoisesdk.config.DEFAULT_VERSION if the environment variable is not set.
debug (bool,basestring) – Controls whether to log information about Identity Services Engine APIs’ request and response process. Defaults to the IDENTITY_SERVICES_ENGINE_DEBUG environment variable or False if the environment variable is not set.
object_factory (callable) – The factory function to use to create Python objects from the returned Identity Services Engine JSON data objects.
validator (callable) – The factory class with function json_schema_validate(model:string) that returns an object with function validate(obj:dict) is used to validate Python objects sent in the request body.

Returns

A new IdentityServicesEngineAPI object.

Return type

IdentityServicesEngineAPI

Raises

TypeError – If the parameter types are incorrect.
AccessTokenError – If an access token is not provided via the access_token argument or an environment variable.
VersionError – If the version is not provided via the version argument or an environment variable, or it is not a Identity Services Engine API supported version [‘3.0.0’].

property uses_api_gateway¶: If the Identity Services Engine API uses an API Gateway.

property session¶: The Identity Services Engine API session.

property session_ui¶: The Identity Services Engine UI API session.

property session_ers¶: The Identity Services Engine ERS API session.

property session_mnt¶: The Identity Services Engine MNT API session.

property session_px_grid¶: The Identity Services Engine PxGrid API session.

property access_token¶: The access token used for API calls to the Identity Services Engine service.

property version¶: The API version of Identity Services Engine.

property verify¶: The verify (TLS Certificate) for the API endpoints.

property base_url¶: The base URL prefixed to the individual API endpoint suffixes for ERS and Custom Caller operations.

property single_request_timeout¶: Timeout (in seconds) for an single HTTP request.

property wait_on_rate_limit¶: Automatic rate-limit handling enabled / disabled.

property ui_base_url¶: The ui base URL prefixed to the individual API endpoint suffixes for UI operations.

property ers_base_url¶: The ers base URL prefixed to the individual API endpoint suffixes for ERS operations.

property mnt_base_url¶: The mnt base URL prefixed to the individual API endpoint suffixes for MNT operations.

property px_grid_base_url¶: The px_grid base URL prefixed to the individual API endpoint suffixes for PxGrid operations

authentication¶

class Authentication[source]¶

Identity Services Engine Authentication API.

Wraps the Identity Services Engine Authentication API and exposes the API as native Python methods that return native Python objects.

property verify¶: The verify (TLS Certificate) for the API endpoints.

property base_url¶: The base URL for the API endpoints.

property single_request_timeout¶: Timeout in seconds for the API requests.

authentication_api(username, password, encoded_auth=None)[source]¶

Exchange basic auth data for a Authorization Basic encoded value that can be used to invoke the APIs.

Parameters

username (basestring) – HTTP Basic Auth username.
password (basestring) – HTTP Basic Auth password.
encoded_auth (basestring) – HTTP Basic Auth base64 encoded string.

Returns

An AccessToken object with the access token provided by the Identity Services Engine cloud.

Return type

AccessToken

Raises

TypeError – If the parameter types are incorrect.

custom_caller¶

class CustomCaller[source]¶

Identity Services Engine CustomCaller.

Identity Services Engine CustomCaller allows API creation.

add_api(name, obj)[source]¶

Adds an api call to the CustomCaller.

Parameters

name (str) – name you want to set to the api client, has to follow python variable naming rule.
obj (object) – api call which is actually a calling call_api method.

call_api(method, resource_path, raise_exception=True, original_response=False, **kwargs)[source]¶

Handles the requests and response.

Parameters

method (basestring) – type of request.
resource_path (basestring) – URL in the request object.
raise_exception (bool) – If True, http exceptions will be raised.
original_response (bool) – If True, MyDict (JSON response) is returned, else response object.
path_params (dict) (optional) – Find each path_params’ key in the resource_path and replace it with path_params’ value.
params (optional) – Dictionary or bytes to be sent in the query string for the Request.
data (optional) – Dictionary, bytes, or file-like object to send in the body of the Request.
json (optional) – json data to send in the body of the Request.
headers (optional) – Dictionary of HTTP Headers to send with the Request.
cookies (optional) – Dict or CookieJar object to send with the Request.
files (optional) – Dictionary of ‘name’: file-like-objects (or {‘name’: (‘filename’, fileobj)}) for multipart encoding upload.
auth (optional) – Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout (float, tuple) (optional) – How long to wait for the server to send data before giving up, as a float, or a (connect timeout, read timeout) tuple.
allow_redirects (bool) (optional) – bool. Set to True if POST/PUT/DELETE redirect following is allowed.
proxies (optional) – Dictionary mapping protocol to the URL of the proxy.
verify (bool,string) (optional) – if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided as a string.
stream (optional) – if False, the response content will be immediately downloaded.
cert (basestring, tuple) (optional) – if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair

Returns

If original_response is True returns the original object response, else returns a JSON response with access to the object’s properties by using the dot notation or the bracket notation. Defaults to False.

Return type

RestResponse or object

Raises

TypeError – If the parameter types are incorrect.
HTTPError – If the Identity Services Engine cloud returns an error.

IdentityServicesEngineAPI v3.0.0¶

aci_bindings¶

class AciBindings[source]¶

Identity Services Engine ACIBindings API (version: 3.0.0).

Wraps the Identity Services Engine ACIBindings API and exposes the API as native Python methods that return native Python objects.

get_aci_bindings(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶

This API allows clients to retrieve all the bindings that were sent to Cisco ISE by ACI or received on ACI from Cisco ISE.The binding information will be identical to the information on ACI bindings page in the Cisco ISE UI. Filtering will be based on one attribute only, such as ip/sgt/vn/psn/learnedFrom/learnedBy with CONTAINS mode of search.

Parameters

page (int) – page query parameter. Page number.
size (int) – size query parameter. Number of objects returned per page.
sort (basestring) – sort query parameter. sort type asc or desc.
sort_by (basestring) – sortBy query parameter. sort column by which objects needs to be sorted.
filter_by (basestring, list, set, tuple) – filterBy query parameter.
filter_value (basestring, list, set, tuple) – filterValue query parameter.
headers (dict) – Dictionary of HTTP Headers to send with the Request .
**query_parameters – Additional query parameters (provides support for parameters that may be added in the future).

Returns

REST response with following properties:

headers(MyDict): response headers.

response(MyDict): response body as a MyDict object. Access the object’s properties by using the dot notation or the bracket notation.

content(bytes): representation of the request’s response

text(str): representation of the request’s response

Return type

User API Doc¶

IdentityServicesEngineAPI¶

IdentityServicesEngineAPI summary structure¶

v3.0.0 summary¶

IdentityServicesEngineAPI Class¶

authentication¶

custom_caller¶

IdentityServicesEngineAPI v3.0.0¶

aci_bindings¶

aci_settings¶

anc_endpoint¶

active_directory¶

admin_user¶

allowed_protocols¶

anc_policy¶

authorization_profile¶

byod_portal¶

backup_and_restore¶

certificate_profile¶

certificate_template¶

certificates¶

clear_threats_and_vulnerabilities¶

consumer¶

device_administration_authentication_rules¶

device_administration_authorization_exception_rules¶

device_administration_authorization_global_exception_rules¶

device_administration_authorization_rules¶

device_administration_command_set¶

device_administration_conditions¶

device_administration_dictionary_attributes_list¶

device_administration_identity_stores¶

device_administration_network_conditions¶

device_administration_policy_set¶

device_administration_profiles¶

device_administration_service_names¶

device_administration_time_date_conditions¶

downloadable_acl¶

egress_matrix_cell¶

endpoint_certificate¶

endpoint_identity_group¶

external_radius_server¶

filter_policy¶

guest_location¶

guest_smtp_notification_configuration¶

guest_ssid¶

guest_type¶

guest_user¶

hotspot_portal¶

ip_to_sgt_mapping¶

ip_to_sgt_mapping_group¶

identity_groups¶

identity_sequence¶

internal_user¶

mdm¶

misc¶

my_device_portal¶

native_supplicant_profile¶

network_access_authentication_rules¶

network_access_authorization_exception_rules¶

network_access_authorization_global_exception_rules¶

network_access_authorization_rules¶

network_access_conditions¶

network_access_dictionary¶

network_access_dictionary_attribute¶

network_access_dictionary_attributes_list¶

network_access_identity_stores¶

network_access_network_conditions¶

network_access_policy_set¶

network_access_profiles¶

network_access_security_groups¶

network_access_service_names¶

network_access_time_date_conditions¶

network_device¶

network_device_group¶

node_deployment¶

node_group¶

node_details¶

pan_ha¶

portal_global_setting¶

portal_theme¶