The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Revised: May 26, 2017, OL-25996-01
This preface explains the objectives, intended audience, and organization of the Cisco Identity Services Engine API Reference Guide, Release 1.0.4. The preface also describes the conventions that provide instructions and provides other types of information in the following sections:
Cisco Identity Services Engine (ISE), as a next-generation identity and access control policy platform enables enterprises to enforce compliance, enhance infrastructure security, and streamline their service operations. The unique architecture of Cisco ISE allows enterprises to gather real-time contextual information from networks, users, and devices in order to make proactive governance decisions by tying identity to various network elements including access switches, wireless LAN controllers (WLCs), virtual private network (VPN) gateways, and data center switches.
Cisco ISE is a key component of the Cisco Security Group Access Solution. Cisco ISE is a consolidated policy-based access control solution that:
Cisco ISE comes preinstalled on a range of physical appliances to suit your network size with various performance characterizations. The inherent scalability of Cisco ISE allows you to add appliances to a deployment and increase performance and resiliency, as needed. The Cisco ISE architecture supports standalone and distributed deployments, along with high availability options. Cisco ISE allows you to configure and manage your network from a centralized portal for efficiency and ease of use.
Cisco ISE also incorporates distinct configurable roles and services, so that you can create and apply Cisco ISE services where they are needed in the network. The result is a comprehensive Cisco ISE deployment that operates as an fully functional and integrated system.
This application programming interface (API) reference guide provides only a brief high-level overview of the capabilities afforded by the supported APIs. The purpose of this API reference guide is to provide a developer, system or network administrator, or system integrator with some basic guidelines for using the capabilities of the APIs to monitor data in selected Cisco Monitoring ISE nodes within the Cisco ISE deployment. The API calls use queries to determine the following types of data:
Note This API reference guide is not intended to replace the Cisco Identity Services Engine User Guide, Release 1.0.4. For more information about the Cisco ISE network, its nodes and personas, concepts of operation or usage, or how to use the Cisco ISE user interface, see the Cisco Identity Services Engine User Guide, Release 1.0.4 (for example, the Glossary contains a complete listing of key terms and concepts used in Cisco ISE networks).
This API reference guide is intended for experienced system administrators who administer Cisco ISE appliances within a network environment, system integrators who may want to make use of the APIs, or third-party partners who have with the responsibility for managing or troubleshooting Cisco ISE deployments. As a prerequisite to using this API reference guide, you should have a basic understanding of troubleshooting and diagnostic practices and how to make and interpret API calls.
Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in this manual.
This API reference guide uses the following conventions to convey instructions and information.
Note We sometimes update the printed and electronic documentation after original publication. Therefore, you should also review the documentation on http://www.cisco.com for any updates.
Table 2 lists the related product documentation that is available for Cisco ISE Release 1.0.4 on www.cisco.com. To find end-user documentation for all products on www.cisco.com, go to:
Table 1 lists the documentation updates for this Cisco ISE product release.
|
|
---|---|
Cisco Identity Services Engine Maintenance Release 1.0.4.573. No content updates made. |
|
Added information on Removing Stale Sessions |
|
This section provides information on release-specific documentation, as well as platform-specific documentation.
Table 2 lists the product documentation available for the Cisco ISE Release. General product information for Cisco ISE is available at http://www.cisco.com/go/ise. End-user documentation is available on Cisco.com at http://www.cisco.com/en/US/products/ps11640/tsd_products_support_series_home.html.
|
|
---|---|
Release Notes for the Cisco Identity Services Engine, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/prod_release_notes_list.html |
Cisco Identity Services Engine Network Component Compatibility, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/products_device_support_tables_list.html |
http://www.cisco.com/en/US/products/ps11640/products_user_guide_list.html |
|
Cisco Identity Services Engine Hardware Installation Guide, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/prod_installation_guides_list.html |
Cisco Identity Services Engine Migration Guide for Cisco Secure ACS 5.1 and 5.2, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/prod_installation_guides_list.html |
Cisco Identity Services Engine Sponsor Portal User Guide, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/products_user_guide_list.html |
Cisco Identity Services Engine CLI Reference Guide, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/prod_command_reference_list.html |
Cisco Identity Services Engine Troubleshooting Guide, Release 1.0.4 |
http://www.cisco.com/en/US/products/ps11640/prod_troubleshooting_guides_list.html |
Regulatory Compliance and Safety Information for Cisco Identity Services Engine, Cisco 1121 Secure Access Control System, Cisco NAC Appliance, Cisco NAC Guest Server, and Cisco NAC Profiler |
http://www.cisco.com/en/US/products/ps11640/prod_installation_guides_list.html |
Cisco Identity Services Engine In-Box Documentation and China RoHS Pointer Card |
http://www.cisco.com/en/US/products/ps11640/products_documentation_roadmaps_list.html |
Links to Policy Management Business Unit documentation are available on www.cisco.com at the following locations:
For information on obtaining documentation, submitting a service request, and gathering additional information, refer to the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.