Cisco Identity Services Engine API Reference Guide, Release 1.2 - Preface [Cisco Identity Services Engine]

Table Of Contents

Preface

Purpose

Audience

Document Organization

Document Conventions

Related Documentation

Release-Specific Documentation

Platform-Specific Documentation

Obtaining Documentation and Submitting a Service Request

Preface

•Purpose

•Audience

•Document Organization

•Document Conventions

•Related Documentation

•Obtaining Documentation and Submitting a Service Request

Purpose

This guide provides a developer, system or network administrator, or system integrator basic guidelines for using the outlined APIs in a Cisco ISE deployment.

The External RESTful Services API and related API calls can be used to perform CRUD (Create, Read, Update, Delete) operations on Cisco ISE resources. The External RESTful Services API is based on HTTP protocol and REST methodology.

Note This guide is not intended to replace Cisco Identity Services Engine User Guide, Release 1.2. For more information about a Cisco ISE network, its nodes and personas, concepts of operation or usage, and how to use the Cisco ISE user interface, see Cisco Identity Services Engine User Guide, Release 1.2.

Audience

This guide is intended for experienced network administrators who administer Cisco ISE appliances, system integrators who want to make use of the APIs, and third-party partners who are responsible for managing and troubleshooting Cisco ISE deployments. As a prerequisite to using it, you should have a basic understanding of troubleshooting and diagnostic practices and how to make and interpret API calls.

Document Organization

•Part 1—Monitoring REST APIs

–Chapter 1 "Introduction to the Monitoring REST API"

–Chapter 2 "Using API Calls for Session Management"

–Chapter 3 "Using API Calls for Troubleshooting"

–Chapter 4 "Using Change of Authorization REST APIs"

•Part 2—External RESTful Services API

–Chapter 5 "Introduction to External RESTful Services API"

–Chapter 6 "External RESTful Services Calls"

•Reference

–"Using the Failure Reasons Report"

Document Conventions

Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in the manual.

Convention

Item

bold

Commands, keywords, and user-entered text as well as tab and button names in procedural text appear in bold font.

italic

Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.

courier

Terminal sessions and information the system displays is in courier (monospace, fixed-width) font.

>

A right-angle bracket (>) surrounded by spaces is used to separate options in a menu path.

< >

In examples that do not allow italics, such as ASCII output, arguments for which you must supply a value appear in angle brackets.

Related Documentation

•Release-Specific Documentation

•Platform-Specific Documentation

Note Updates to printed and electronic documentation can be found at http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.

Release-Specific Documentation

Table 1 Product Documentation for Cisco Identity Services Engine

Document Title

Location

Release Notes for the Cisco Identity Services Engine, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
prod_release_notes_list.html

Cisco Identity Services Engine Network Component Compatibility, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
products_device_support_tables_list.html

Cisco Identity Services Engine User Guide, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
products_user_guide_list.html

Cisco Identity Services Engine Hardware Installation Guide, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
prod_installation_guides_list.html

Cisco Identity Services Engine, Release 1.2 Migration Tool Guide

http://www.cisco.com/en/US/products/ps11640/
prod_installation_guides_list.html

Cisco Identity Services Engine Sponsor Portal User Guide, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
products_user_guide_list.html

Cisco Identity Services Engine CLI Reference Guide, Release 1.2

http://www.cisco.com/en/US/products/ps11640/
prod_command_reference_list.html

Cisco Identity Services Engine Troubleshooting Guide, Release 1.2

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

Platform-Specific Documentation

•Cisco ISE
http://www.cisco.com/en/US/products/ps11640/index.html

•Cisco Secure Access Control Server (ACS)
http://www.cisco.com/en/US/products/ps9911/tsd_products_support_series_home.html

•Cisco NAC Appliance
http://www.cisco.com/en/US/products/ps6128/tsd_products_support_series_home.html

•Cisco NAC Profiler
http://www.cisco.com/en/US/products/ps8464/tsd_products_support_series_home.html

•Cisco NAC Guest Server
http://www.cisco.com/en/US/products/ps10160/tsd_products_support_series_home.html

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation at: http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html.

Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation, as an RSS feed and deliver content directly to your desktop using a reader application. The RSS feeds are a free service.