ciscoisesdk¶

Simple, lightweight, scalable Python API wrapper for the Identity Services Engine APIs

Welcome to the docs! ciscoisesdk is a community developed Pythonic wrapping of the Identity Services Engine APIs (for API versions: 3.0.0). The package represents all of the Cisco Identity Services Engine API interactions via native Python tools. Making working with the Cisco Identity Services Engine APIs in Python a native and natural experience.

ciscoisesdk helps you get things done faster. We take care of the API semantics, and you can focus on writing your code.

With ciscoisesdk, you can easily:

Interact with the Identity Services Engine APIs in an interactive Python session
Quickly create code that enables you get something done in Identity Services Engine
Leverage the API wrapper to cleanly add Identity Services Engine functionality to your project without having to write the boilerplate code for working with the Identity Services Engine APIs

To dive in and see how ciscoisesdk makes your life better, check out the Quickstart!

The User Guide¶

Installation¶

PIP Install¶

ciscoisesdk is available via PIP and the Python Package Index (PyPI). To install ciscoisesdk, simply run this command from your terminal of choice:

$ pip install ciscoisesdk

The ciscoisesdk package is distributed as a source distribution (no binaries).

PIP Upgrade¶

To ensure that you have the latest version, check-for and install upgrades via PIP:

$ pip install ciscoisesdk --upgrade

Get the Source Code¶

ciscoisesdk is developed on GitHub. If you like and use this package, please take a few seconds to Star the package on the CiscoISE/ciscoisesdk GitHub page. Your feedback and contributions are always welcome.

Use the following command to download the source code (GIT repository):

$ git clone https://github.com/CiscoISE/ciscoisesdk.git

You can then install the package to your environment, with the following command:

$ python setup.py install

Introduction¶

Work with the Identity Services Engine APIs in Native Python!¶

Sure, working with the Identity Services Engine APIs is easy (see api_docs). They are RESTful, naturally structured, require only a simple Access Token for authentication, and the data is elegantly represented in intuitive JSON. What could be easier?

import requests

URL = 'https://dcloud-dna-ise-rtp.cisco.com/ers/config/networkdevice'
ACCESS_TOKEN = '<your_access_token>'

filter_query = '<filter_query>'
headers = {'authorization': ACCESS_TOKEN,
           'Content-type': 'application/json;charset=utf-8'}
params_data = { 'filter': filter_query }
response = requests.get(URL, params=params_data, headers=headers)
if response.status_code == 200:
    device_response = response.json
    if device_response.get('SearchResult') and device_response['SearchResult'].get('resources'):
    for device in device_response['SearchResult']['resources']:
        print('{:20s}{}'.format(device['id'], device['name']))
else:
    # Oops something went wrong...  Better do something about it.
    print(response.status_code, response.text)

Like I said, EASY. However, in use, the code can become rather repetitive…

You have to setup the environment every time
You have to remember URLs, request parameters and JSON formats (or reference the docs)
You have to parse the returned JSON and work with multiple layers of list and dictionary indexes

Enter ciscoisesdk, a simple API wrapper that wraps all of the Identity Services Engine API calls and returned JSON objects within native Python objects and methods.

With ciscoisesdk, the above Python code can be consolidated to the following:

from ciscoisesdk import api

api_ = api.IdentityServicesEngineAPI(username='admin',
                                     password='C1sco12345',
                                     uses_api_gateway=True,
                                     base_url='https://dcloud-dna-ise-rtp.cisco.com',
                                     version='3.0.0',
                                     verify=True)
# Or even just api_ = api.IdentityServicesEngineAPI(username='admin', password='C1sco12345') as others have those values by default.
try:
    device_response = api_.network_device.get_all_network_device(filter='name.EQ.Test').response
    if device_response.SearchResult and device_response.SearchResult.resources:
        for device in device_response.SearchResult.resources:
            print('{:20s}{}'.format(device.hostname, device.upTime))
except ApiError as e:
    print(e)

ciscoisesdk handles all of this for you:

Reads your Identity Services Engine credentials from environment variables (IDENTITY_SERVICES_ENGINE_ENCODED_AUTH, IDENTITY_SERVICES_ENGINE_USERNAME, IDENTITY_SERVICES_ENGINE_PASSWORD)
Reads your Identity Services Engine API version from environment variable IDENTITY_SERVICES_ENGINE_VERSION. Supported versions: 3.0.0. Now with version and base_url, you have more control.
Controls whether to verify the server’s TLS certificate or not according to the verify parameter.
Reads your Identity Services Engine debug from environment variable IDENTITY_SERVICES_ENGINE_DEBUG. Boolean, it controls whether to log information about Identity Services Engine APIs’ request and response process.
Wraps and represents all Identity Services Engine API calls as a simple hierarchical tree of native-Python methods (with default arguments provided everywhere possible!)
If your Python IDE supports auto-completion (like PyCharm), you can navigate the available methods and object attributes right within your IDE
Represents all returned JSON objects as native Python objects - you can access all of the object’s attributes using native dot.syntax
Automatic Rate-Limit Handling Sending a lot of requests to Identity Services Engine? Don’t worry; we have you covered. Identity Services Engine will respond with a rate-limit response, which will automatically be caught and “handled” for you. Your requests and script will automatically be “paused” for the amount of time specified by Identity Services Engine, while we wait for the Identity Services Engine rate-limit timer to cool down. After the cool-down, your request will automatically be retried, and your script will continue to run as normal. Handling all of this requires zero (0) changes to your code - you’re welcome. 😎

Just know that if you are are sending a lot of requests, your script might take longer to run if your requests are getting rate limited.

All of this, combined, lets you do powerful things simply:

from ciscoisesdk import IdentityServicesEngineAPI
from ciscoisesdk.exceptions import ApiError

# Get allowed protocols
search_result = api_.allowed_protocols.get_all_allowed_protocols().response.SearchResult
if search_result and search_result.resources:
  for resource in search_result.resources:
    resource_detail = api_.allowed_protocols.get_allowed_protocol_by_id(resource.id).response.AllowedProtocols
    print("Id {}\nName {}\nallowChap {}\n".format(resource_detail.id, resource_detail.name, resource_detail.allowChap))

# Filter network device
device_list_response = api_.network_device.get_all_network_device(filter='name.EQ.ISE_EST_Local_Host_19')
device_responses = device_list_response.response.SearchResult.resources
device_response = device_responses[0]

# Get network device detail
device_response_detail = api_.network_device.get_network_device_by_id(device_response.id).response.NetworkDevice

# Delete network device
delete_device = api_.network_device.delete_network_device_by_id(device_response.id)

# Create network device
try:
    network_device_response = api_.network_device.create_network_device(name='ISE_EST_Local_Host_19', network_device_iplist=[{"ipaddress": "127.35.0.1", "mask": 32}])
    print("Created, new Location {}".format(network_device_response.headers.Location))
except api_Error as e:
    print(e)

Head over to the Quickstart page to begin working with the Identity Services Engine APIs in native Python!

MIT License¶

ciscoisesdk is currently licensed under the MIT Open Source License, and distributed as a source distribution (no binaries) via PyPI, and the complete source code is available on GitHub.

ciscoisesdk License¶

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Quickstart¶

Dive in! …to get started using the ciscoisesdk package:

Make sure that you have:

ciscoisesdk installed
ciscoisesdk upgraded to the latest version

Pass your Identity Services Engine Access Token¶

To interact with the Identity Services Engine APIs, you must have a Identity Services Engine Access Token. A Identity Services Engine Access Token is how the Identity Services Engine APIs validate access and identify the requesting user.

As a best practice, you can store your Identity Services Engine ‘credentials’ as an environment variables in your development or production environment.

By default, ciscoisesdk will look for the following environment variables to create new connection objects:

IDENTITY_SERVICES_ENGINE_DEBUG - Tells the SDK whether to log request and response information. Useful for debugging and seeing what is going on under the hood. Defaults to False.

IDENTITY_SERVICES_ENGINE_VERSION - Identity Services Engine API version to use. Defaults to ‘3.0.0’.

IDENTITY_SERVICES_ENGINE_ENCODED_AUTH - It takes priority. It is the username:password encoded in base 64. For example ‘ZGV2bmV0dXNlcjpDaXNjbzEyMyEK’ which decoded is ‘devnetuser:Cisco123!’

IDENTITY_SERVICES_ENGINE_USERNAME - HTTP Basic Auth username.

IDENTITY_SERVICES_ENGINE_PASSWORD - HTTP Basic Auth password.

IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY - Enables or disables the usage of the API Gateway. Defaults to True.

IDENTITY_SERVICES_ENGINE_BASE_URL - The base URL to be prefixed to the individual API endpoint suffixes. It is used if the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY is True. Defaults to ‘https://dcloud-dna-ise-rtp.cisco.com’.

IDENTITY_SERVICES_ENGINE_UI_BASE_URL - The UI base URL to be prefixed to the individual ISE UI API endpoint suffixes. It is used if the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY is False.

IDENTITY_SERVICES_ENGINE_ERS_BASE_URL - The ERS base URL to be prefixed to the individual ISE ERS API endpoint suffixes. It is used if the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY is False.

IDENTITY_SERVICES_ENGINE_MNT_BASE_URL - The MNT base URL to be prefixed to the individual ISE MNT API endpoint suffixes. It is used if the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY is False.

IDENTITY_SERVICES_ENGINE_PX_GRID_BASE_URL - The PX_GRID base URL to be prefixed to the individual ISE PX_GRID API endpoint suffixes. It is used if the IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY is False.

IDENTITY_SERVICES_ENGINE_SINGLE_REQUEST_TIMEOUT - Timeout (in seconds) for RESTful HTTP requests. Defaults to 60.

IDENTITY_SERVICES_ENGINE_WAIT_ON_RATE_LIMIT - Enables or disables automatic rate-limit handling. Defaults to True.

IDENTITY_SERVICES_ENGINE_VERIFY - Controls whether to verify the server’s TLS certificate or not. Defaults to True.

However, you choose to set it, if you have IDENTITY_SERVICES_ENGINE_VERSION, IDENTITY_SERVICES_ENGINE_USERNAME and IDENTITY_SERVICES_ENGINE_PASSWORD, or IDENTITY_SERVICES_ENGINE_VERSION and IDENTITY_SERVICES_ENGINE_ENCODED_AUTH environment variables, you are good to go. ciscoisesdk will use them to create your access token when creating new IdentityServicesEngineAPI objects.

If you don’t want to set your credentials as environment variables, you can manually provide them as parameters when creating a IdentityServicesEngineAPI object.

Note

The ciscoisesdk assumes that the ERS APIs and OpenAPIs are enabled. If uses_api_gateway is True, the ciscoisesdk assumes that your ISE API Gateway is enabled as well.

Set credentials as environment variables¶

There are many places and diverse ways that you can set an environment variable, which can include:

A setting within your development IDE

A setting in your container / PaaS service

A statement in a shell script that configures and launches your app

It can be as simple as setting it in your CLI before running your script…

$ IDENTITY_SERVICES_ENGINE_USERNAME=your_username_here
$ IDENTITY_SERVICES_ENGINE_PASSWORD=your_password_here
$ python myscript.py

…or putting your credentials in a shell script that you source when your shell starts up or before your run a script:

$ cat mycredentials.sh
export IDENTITY_SERVICES_ENGINE_ENCODED_AUTH=your_encoded_auth_here
$ source mycredentials.sh
$ python myscript.py

Create a IdentityServicesEngineAPI “Connection Object”¶

To make interacting with the Identity Services Engine APIs as simple and intuitive as possible, all of the APIs have ‘wrapped’ underneath a single interface. To get started, import the IdentityServicesEngineAPI class and create an API “connection object”.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> api = IdentityServicesEngineAPI()

As discussed above (Pass your Identity Services Engine Access Token), ciscoisesdk defaults to pulling from environment variables to generate your access token. If you do not have those environment variables set and you try to create a new IdentityServicesEngineAPI object without providing them, a AccessTokenError will be raised (a ciscoisesdkException subclass).

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> api = IdentityServicesEngineAPI()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ciscoisesdk/api/__init__.py", line 356, in __init__
    raise AccessTokenError(error_message)
AccessTokenError: You need an access token to interact with the Identity Services Engine
APIs. Identity Services Engine uses HTTP Basic Auth to create an access
token. You must provide the username and password or just
the encoded_auth, either by setting each parameter or its
environment variable counterpart (IDENTITY_SERVICES_ENGINE_USERNAME,
IDENTITY_SERVICES_ENGINE_PASSWORD, IDENTITY_SERVICES_ENGINE_ENCODED_AUTH).

If you don’t provide a known version and try to create a new IdentityServicesEngineAPI, a VersionError will be raised.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> api = IdentityServicesEngineAPI(username='devnetuser',
                                    password='Cisco123!',
                                    base_url='https://dcloud-dna-ise-rtp.cisco.com',
                                    version='0.1.12')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ciscoisesdk/api/__init__.py", line 344, in __init__
    raise VersionError(error_message)
VersionError: Unknown API version, known versions are 3.0.0.

Use the arguments to manually provide enough information for the HTTP Basic Auth process, when creating a new IdentityServicesEngineAPI connection object.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> # Create a IdentityServicesEngineAPI connection object;
>>> # Using encoded_auth, with Identity Services Engine API version 3.0.0
>>> api = IdentityServicesEngineAPI(encoded_auth='YWRtaW46QzFzY28xMjM0NQo=',
...                                 base_url="https://dcloud-dna-ise-rtp.cisco.com",
...                                 version='3.0.0',
...                                 uses_api_gateway=True)
>>> # Create a IdentityServicesEngineAPI connection object;
>>> # Using username, and password, with ISE API version 3.0.0
>>> api = IdentityServicesEngineAPI(username='admin', password='C1sco12345',
...                                 uses_api_gateway=True,
...                                 base_url="https://dcloud-dna-ise-rtp.cisco.com",
...                                 version='3.0.0')

Use the arguments to provide the URLs required depending on the uses_api_gateway value.

Note

If uses_api_gateway is True, the ciscoisesdk assumes that your ISE API Gateway is enabled.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> # Create a IdentityServicesEngineAPI connection object;
>>> # Using API Gateway (since it was enabled on ISE)
>>> api = IdentityServicesEngineAPI(username='admin',
...                                 password='C1sco12345',
...                                 uses_api_gateway=True,
...                                 base_url='https://dcloud-dna-ise-rtp.cisco.com',
...                                 version='3.0.0',
...                                 verify=True)
>>> # Not using API Gateway
>>> api = IdentityServicesEngineAPI(username='devnetuser', password='Cisco123!',
...                                 uses_api_gateway=False,
...                                 ers_base_url="https://dcloud-dna-ise-rtp.cisco.com:9060",
...                                 ui_base_url="https://dcloud-dna-ise-rtp.cisco.com:443",
...                                 mnt_base_url="https://dcloud-dna-ise-rtp.cisco.com:443",
...                                 px_grid_base_url="https://dcloud-dna-ise-rtp.cisco.com:8910",
...                                 version='3.0.0')

Note that this can be very useful if you are reading authentication credentials from a file or database and/or when you want to create more than one connection object.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> kingston_auth = 'ZG5hY2VudGVydXNlcjpDaXNjbzEyMyEK'
>>> london_auth = ('london', 'rcx0cf43!')
>>> kingston_api = IdentityServicesEngineAPI(encoded_auth=kingston_auth, base_url="https://dcloud-dna-ise-rtp.cisco.com", version='3.0.0')
>>> london_api = IdentityServicesEngineAPI(*london_auth, base_url="https://128.107.71.199:443",
...                                        version='3.0.0', uses_api_gateway=True)  # * Unpacks tuple

API Gateway¶

If uses_api_gateway is True, the ciscoisesdk assumes that the API Gateway is enabled.

If uses_api_gateway is True you only need to set your base_url.

If uses_api_gateway is False you need to set the ers_base_url, ui_base_url, mnt_base_url and px_grid_base_url.

Warning

Ensure that you have enabled the ERS APIs and OpenAPIs.
Make sure to check the ISE settings for the API Gateway, and set the uses_api_gateway accordingly.

If you don’t provide the URLs necessary and try to create a new IdentityServicesEngineAPI, a TypeError will be raised.

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> # Create a IdentityServicesEngineAPI connection object;
>>> # it uses Identity Services Engine username and password, with ISE API version 3.0.0
>>> # The base_url used by default is `from ciscoisesdk.config import DEFAULT_BASE_URL`
>>> api = IdentityServicesEngineAPI(username='admin',
...                                 password='C1sco12345',
...                                 uses_api_gateway=True,
...                                 base_url=None,
...                                 version='3.0.0',
...                                 verify=True)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    api = IdentityServicesEngineAPI(username='admin',
  File "ciscoisesdk/api/__init__.py", line 336, in __init__
  File "ciscoisesdk/utils.py", line 165, in check_type
TypeError: We were expecting to receive an instance of one of the following types:
'basestring'; but instead we received None which is a 'NoneType'.

>>> # Other way to create IdentityServicesEngineAPI connection object; if it does not use the API Gateway
>>> api = IdentityServicesEngineAPI(username='devnetuser', password='Cisco123!',
...                                 uses_api_gateway=False,
...                                 ers_base_url="https://dcloud-dna-ise-rtp.cisco.com:9060",
...                                 ui_base_url="https://dcloud-dna-ise-rtp.cisco.com:443",
...                                 mnt_base_url="https://dcloud-dna-ise-rtp.cisco.com:443",
...                                 # px_grid_base_url="https://dcloud-dna-ise-rtp.cisco.com:8910",
...                                 version='3.0.0')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    api = IdentityServicesEngineAPI(username='admin',
  File "ciscoisesdk/api/__init__.py", line 341, in __init__
  File "ciscoisesdk/utils.py", line 165, in check_type
TypeError: We were expecting to receive an instance of one of the following types:
'basestring'; but instead we received None which is a 'NoneType'.

Certificates¶

Besides username, password, encoded_auth, base_url, and version, there are other parameters when creating the IdentityServicesEngineAPI, many of them have a default value (check Package Constants for more).

When dealing with certificates, the most important one is the verify parameter.

To avoid getting errors like the following:

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> own_api = IdentityServicesEngineAPI(encoded_auth='dXNlcm5hbWU6cGFzc3dvcmQK',
... base_url="https://128.107.71.199:443", version='3.0.0', uses_api_gateway=True)
requests.exceptions.SLError: HTTPSConnectionPool(host='128.107.71.199', port=443):
Max retries exceeded with url: /dna/system/api/v1/auth/token (Caused by
SSLError (SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate
verify failed: self signed certificate in certificate chain (_ssl.c:1076)')))
>>>

Include the verify parameter and set it to False:

>>> from ciscoisesdk import IdentityServicesEngineAPI
>>> own_api = IdentityServicesEngineAPI(encoded_auth='dXNlcm5hbWU6cGFzc3dvcmQK',
... base_url="https://128.107.71.199:443", version='1.3.0',
... verify=False)
InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate
 verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
  InsecureRequestWarning)
>>>

You will see urllib3 warnings instead. If you want to disable them, the easiest way is with:

>>> import urllib3
>>> urllib3.disable_warnings()

Package Constants¶

The following are the default values pulled from ciscoisesdk.config and used when creating the connection object.

DEFAULT_DEBUG = 'False'¶: debug default value.

DEFAULT_VERSION = '3.0.0'¶: version default value.

DEFAULT_BASE_URL = 'https://dcloud-dna-ise-rtp.cisco.com'¶: base_url default value.

DEFAULT_SINGLE_REQUEST_TIMEOUT = 60¶: single_request_timeout default value. Timeout (in seconds) for the RESTful HTTP requests.

DEFAULT_WAIT_ON_RATE_LIMIT = True¶: wait_on_rate_limit default value. Enables or disables automatic rate-limit handling.

DEFAULT_VERIFY = True¶: verify default value. Controls whether to verify the server’s TLS certificate or not.

DEFAULT_USES_API_GATEWAY = True¶: uses_api_gateway default value. Controls whether ISE use the gateway or not.

USES_API_GATEWAY_ENVIRONMENT_VARIABLE = 'IDENTITY_SERVICES_ENGINE_USES_API_GATEWAY'¶: name of the environment uses_api_gateway variable

UI_BASE_URL_ENVIRONMENT_VARIABLE = 'IDENTITY_SERVICES_ENGINE_UI_BASE_URL'¶: name of the environment ui_base_url variable

ERS_BASE_URL_ENVIRONMENT_VARIABLE = 'IDENTITY_SERVICES_ENGINE_ERS_BASE_URL'¶: name of the environment ers_base_url variable

MNT_BASE_URL_ENVIRONMENT_VARIABLE = 'IDENTITY_SERVICES_ENGINE_MNT_BASE_URL'¶: name of the environment mnt_base_url variable

PX_GRID_BASE_URL_ENVIRONMENT_VARIABLE = 'IDENTITY_SERVICES_ENGINE_PX_GRID_BASE_URL'¶: name of the environment px_grid_base_url variable

Making API Calls¶

Now that you have created a IdentityServicesEngineAPI “connection object,” you are ready to start making API calls.

>>> api.network_device.get_all_network_device(page=1,size=3).response.SearchResult.resources
[{'id': '4969bc30-ad2a-11eb-95af-f263cf05f605',
  'name': 'ISE_EST_Local_Host_19',
  'description': '',
  'link': {'rel': 'self',
  'href': 'https://198.18.133.27/ers/config/networkdevice/4969bc30-ad2a-11eb-95af-f263cf05f605',
  'type': 'application/json'}},
{'id': 'a56f6360-a9fe-11eb-95af-f263cf05f605',
  'name': 'ISE_EST_Local_Host_92348',
  'description': '',
  'link': {'rel': 'self',
  'href': 'https://198.18.133.27/ers/config/networkdevice/a56f6360-a9fe-11eb-95af-f263cf05f605',
  'type': 'application/json'}},
{'id': '2ea03580-aa02-11eb-95af-f263cf05f605',
  'name': 'Test_Device_4',
  'description': '',
  'link': {'rel': 'self',
  'href': 'https://198.18.133.27/ers/config/networkdevice/2ea03580-aa02-11eb-95af-f263cf05f605',
  'type': 'application/json'}}]

It really is that easy.

All of the calls have been wrapped and represented as native Python method calls, like IdentityServicesEngineAPI.network_device.get_all_network_device() which gets the network devices summaries for the Cisco ISE ERS - see the Network Device - Get All API endpoint documentation.

As you can see, we have represented the API endpoints using simple terms that are aligned with the API docs; for example, representing the /ers/config/networkdevice API endpoint as a network_device.get_all_network_device() method available underneath the IdentityServicesEngineAPI connection object.

A full list of the available API methods, with their descriptions and parameters, is available in the User API Doc.

A summary of the structure is available for each version supported

v3.0.0

You can easily access and call any of these methods directly from your IdentityServicesEngineAPI connection object:

>>> api.network_access_policy_set.get_all_network_access_policy_sets().response.response
[{'default': False,
  'id': 'f22b6a01-759b-47e2-99ea-2e062abdb6ed',
  'name': 'Test Policy Set 1',
  'description': 'Test Policy Set',
  'hitCounts': 0,
  'rank': 0,
  'state': 'enabled',
  'condition': {'link': None,
  'conditionType': 'ConditionReference',
  'isNegate': False,
  'name': 'My New Condition',
  'id': '92bba708-1df6-4f03-9d40-d28b4cb2d982',
  'description': 'New optional Description'},
  'serviceName': 'Default Network Access',
  'isProxy': False,
  'link': {'rel': 'self',
  'href': 'https://198.18.133.27/api/v1/policy/network-access/policy-set/f22b6a01-759b-47e2-99ea-2e062abdb6ed',
  'type': 'application/json'}}]

Catching Exceptions¶

If something should go wrong with the API call, an exception will be raised. ApiError exceptions are raised when an error condition is returned from the Identity Services Engine cloud. Details will be provided in the error message.

>>> from ciscoisesdk import IdentityServicesEngineAPI, ApiError
>>> api = IdentityServicesEngineAPI(username='devnetuser', password='Cisco123!')
>>> # The uses_api_gateway is True by default and the base_url used by default is `from ciscoisesdk.config import DEFAULT_BASE_URL`
>>> network_device_response = api.network_device.create_network_device(name='ISE_EST_Local_Host_19', network_device_iplist=[{"ipaddress": "127.35.0.1", "mask": 32}])
---------------------------------------------------------------------------
ApiError                                  Traceback (most recent call last)
<ipython-input-71-afadb5c98c43> in <module>
----> 1 network_device_response = api.network_device.create_network_device(name='ISE_EST_Local_Host_19', network_device_iplist=[{"ipaddress": "127.35.0.1", "mask": 32}])
      2
ciscoisesdk/utils.py in check_response_code(response, expected_response_code)
    215         raise RateLimitError(response)
    216     else:
--> 217         raise ApiError(response)
    218
    219
ApiError: [400] - The request was invalid or cannot be otherwise served.
{
  "ERSResponse" : {
    "operation" : "POST-create-networkdevice",
    "messages" : [ {
      "title" : "Network Device Create failed: Device Name Already Exist",
      "type" : "ERROR",
      "code" : "Application resource validation exception"
    } ],
    "link" : {
      "rel" : "related",
      "href" : "https://198.18.133.27/ers/config/networkdevice",
      "type" : "application/xml"
    }
  }
}
>>>

You can catch any errors returned by the Identity Services Engine cloud by catching ApiError exceptions in a try-except block.

>>> from ciscoisesdk.exceptions import ApiError
>>> try:
...     network_device_response = api.network_device.create_network_device(name='ISE_EST_Local_Host_19', network_device_iplist=[{"ipaddress": "127.35.0.1", "mask": 32}])
... except ApiError as e:
...     print(e)
ApiError: [400] - The request was invalid or cannot be otherwise served.
{
  "ERSResponse" : {
    "operation" : "POST-create-networkdevice",
    "messages" : [ {
      "title" : "Network Device Create failed: Device Name Already Exist",
      "type" : "ERROR",
      "code" : "Application resource validation exception"
    } ],
    "link" : {
      "rel" : "related",
      "href" : "https://198.18.133.27/ers/config/networkdevice",
      "type" : "application/xml"
    }
  }
}
>>>

ciscoisesdk will also raise a number of other standard errors (TypeError, ValueError, etc.); however, these errors are usually caused by incorrect use of the package or methods and should be sorted while debugging your app.

Working with Returned Objects¶

The Identity Services Engine cloud returns data objects in JSON format, like so:

[
  {
    "default": false,
    "id": "f22b6a01-759b-47e2-99ea-2e062abdb6ed",
    "name": "Test Policy Set 1",
    "description": "Test Policy Set",
    "hitCounts": 0,
    "rank": 0,
    "state": "enabled",
    "condition": {
      "link": null,
      "conditionType": "ConditionReference",
      "isNegate": false,
      "name": "My New Condition",
      "id": "92bba708-1df6-4f03-9d40-d28b4cb2d982",
      "description": "New optional Description"
    },
    "serviceName": "Default Network Access",
    "isProxy": false,
    "link": {
      "rel": "self",
      "href": "https://198.18.133.27/api/v1/policy/network-access/policy-set/f22b6a01-759b-47e2-99ea-2e062abdb6ed",
      "type": "application/json"
    }
  }
]

Sure, JSON data objects can easily be parsed and represented in Python using dictionaries, but when working with an ‘object’ wouldn’t it be nice to be able to work with it like an object - using native object syntax (like accessing attributes using ‘.’ notation)? ciscoisesdk enables you to do just that:

>>> policy_set = api.network_access_policy_set.get_all_network_access_policy_sets().response.response
>>> policy_set[0].id
'f22b6a01-759b-47e2-99ea-2e062abdb6ed'
>>> policy_set[0].condition.conditionType
'ConditionReference'
>>> policy_set[0].condition.name
'My New Condition'

Representing and treating Identity Services Engine data objects as Python data objects, can really help clean up your code and make coding easier:

You don’t need to create variables to hold all the data attributes, just use the attributes available underneath the data object.

>>> # Do this
>>> device_list_response = api.network_device.get_all_network_device(filter='name.EQ.ISE_EST_Local_Host_19')
>>> device_response = device_list_response.response.SearchResult.resources[0]
>>> device_response_detail = api.network_device.get_network_device_by_id(device_response.id).response.NetworkDevice

>>> # or even this
>>> filter_query = 'name.EQ.ISE_EST_Local_Host_19'
>>> device_response_id = api.network_device.get_all_network_device(filter=filter_query).response.SearchResult.resources[0].id
>>> device_response_detail = api.network_device.get_network_device_by_id(device_response_id).response.NetworkDevice

When accessing ‘optional’ attributes, like device_list_response.response.SearchResult.resources[0].id attribute of Identity Services Engine NetworkDevice object, the response object will return None when the attribute is not present and will return the attribute’s value when it is present. This avoids some boiler plate code and/or needless exception handling, when working with optional attributes.

>>> devices_response = api.network_device.get_all_network_device().response
>>> # Instead of doing this
>>> if hasattr(devices_response, 'SearchResult') and hasattr(devices_response.SearchResult, 'resources'):
...     devices = devices_response.SearchResult.resources
...     for d in devices:
...          if hasattr(d, 'id') and hasattr(d, 'description'):
...              # Do something with the configList attribute
...              print(d.id, d.description)
>>> # Or this
... try:
...     devices = devices_response.SearchResult.resources
... except AttributeError as e:
...     pass
... for d in devices:
...      # Do something with the configList attribute
...      print(d.id, d.description)
... except AttributeError as e:
...     pass
>>> # You can do this, which is cleaner
>>> if devices_response.SearchResult and devices_response.SearchResult.resources:
...      for d in devices_response.SearchResult.resources:
...          if d.id and d.description:
...              # Do something with the configList attribute
...              print(d.id, d.description)

It just feels more natural. :-) When iterating through sequences, and working with objects in those sequences (see the next section), working with objects as objects is definitely more Pythonic.

The Zen of Python (PEP 20):
“Beautiful is better than ugly.” “Simple is better than complex.”

The currently modeled Identity Services Engine Data Object with its functions, is available here in the User API Doc.

What if Identity Services Engine adds new data attributes?

Attribute access WILL WORK for the newly added attributes (yes, without a package update!). ciscoisesdk is written to automatically take advantage of new attributes and data as they are returned.

Configuring Logging for ciscoisesdk¶

The main ciscoisesdk logger is ciscoisesdk.

Other loggers are ciscoisesdk.exceptions, ciscoisesdk.restsession and ciscoisesdk.api.custom_caller.

The ciscoisesdk adds only the logging.NullHandler following the logging recommendations for libraries

So you can add your logging handlers according to your needs.

import logging
import warnings
from ciscoisesdk import IdentityServicesEngineAPI

# Another way to disable warnings caused by (verify=False)
warnings.filterwarnings('ignore', message='Unverified HTTPS request')

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# create console handler and set level to debug
ch = logging.StreamHandler()
# create formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
# add formatter to ch
ch.setFormatter(formatter)
# add ch to logger
logger.addHandler(ch)

ch_ = logging.StreamHandler()
api = IdentityServicesEngineAPI(verify=False, debug=True)
logging.getLogger('ciscoisesdk').addHandler(ch_)

logger.debug('simple message')
api.network_device.get_all_network_device().response

Adding API call definitions¶

Custom caller functions help you:

Add support for custom API calls.

Add support for API calls that are/were not documented when the SDK was released.

from ciscoisesdk import api

# Create a IdentityServicesEngineAPI connection object;
# it uses Identity Services Engine sandbox URL, username and password, with Identity Services Engine API version 3.0.0.,
# and requests to verify the server's TLS certificate with verify=True.
api_ = api.IdentityServicesEngineAPI(username="devnetuser",
    password="Cisco123!",
    base_url="https://dcloud-dna-ise-rtp.cisco.com",
    version='3.0.0',
    verify=True
)

# Add your custom API call to the connection object.
# Define the get_hotspotportal function.
# Call it with:
#     get_hotspotportal(params={'filter': 'name.EQ.Hotspot Guest Portal'})
def get_hotspotportal(params):
    return api_.custom_caller.call_api('GET', '/ers/config/hotspotportal', params)

# Add your custom API call to the connection object.
# Define the delete_hotspotportal_by_id function
# under the custom_caller wrapper.
# Call it with:
#     api_.custom_caller.delete_hotspotportal_by_id('be456g16-14fd-4cac-94b7-ac3b8f9f')
api_.custom_caller.add_api('delete_hotspotportal_by_id',
                           lambda _id:
                               api_.custom_caller.call_api(
                                   'DELETE',
                                   '/ers/config/hotspotportal/{id}',
                                   path_params={
                                       'id': _id,
                                   })
                           )

# Advance usage example using Custom Caller functions.
def setup_custom():
    """
    Defines the get_hotspotportal_by_id and delete_hotspotportal_by_id functions
    under the custom_caller wrapper, and with help documentation
    in two different ways.

    Check that they have been added with
        'get_hotspotportal_by_id' in dir(api_.custom_caller)
        'delete_hotspotportal_by_id' in dir(api_.custom_caller)

    Quickly check that you indeed have them as functions with
        type(getattr(api_.custom_caller, 'get_hotspotportal_by_id'))
        type(getattr(api_.custom_caller, 'delete_hotspotportal_by_id'))

    Check the documentation with
        help(api_.custom_caller.get_hotspotportal_by_id)
        help(api_.custom_caller.delete_hotspotportal_by_id)

    """

    # Alternative 1: Definition with helper function.
    def _get_hotspotportal_by_id(_id):
        """Custom hostport portal API call, returns response attribute

            Args:
                _id(str): Hostport portal id.

            Returns:
                RestResponse: 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 api_.custom_caller.call_api(
                                          'GET',
                                          '/ers/config/hotspotportal/{id}',
                                          path_params={
                                              'id': _id,
                                          })
    # Finally add the function as an attribute.
    api_.custom_caller.add_api('get_hotspotportal_by_id', _get_hotspotportal_by_id)

    # Alternative 2: Definition with lambda function.
    api_.custom_caller.add_api('delete_hotspotportal_by_id',
                               lambda _id:
                                   api_.custom_caller.call_api(
                                       'DELETE',
                                       '/ers/config/hotspotportal/{id}',
                                       path_params={
                                           'id': _id,
                                       })
                               )
    # Finally add the documentation
    api_.custom_caller.delete_hotspotportal_by_id.__doc__ = """
        Custom global credential API call to delete hostport portal

        Args:
            _id(str): Hostport portal id.

        Returns:
            RestResponse: 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
        """

Check out the Custom Caller documentation to begin using it.

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_all_aci_bindings()` `get_all_aci_bindings_generator()`
	aci_settings	`get_all_aci_settings()` `test_aci_connectivity()` `update_aci_settings_by_id()`
	active_directory	`create_active_directory()` `delete_active_directory_by_id()` `get_active_directory_by_id()` `get_active_directory_by_name()` `get_all_active_directory()` `get_all_active_directory_generator()` `get_all_trusted_domains()` `get_all_user_groups()` `get_groups_by_domain()` `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_all_admin_users()` `get_all_admin_users_generator()`
	allowed_protocols	`create_allowed_protocol()` `delete_allowed_protocol_by_id()` `get_all_allowed_protocols()` `get_all_allowed_protocols_generator()` `get_allowed_protocol_by_id()` `get_allowed_protocol_by_name()` `update_allowed_protocol_by_id()`
	anc_endpoint	`apply_anc_endpoint()` `bulk_request_for_anc_endpoint()` `clear_anc_endpoint()` `get_all_anc_endpoint()` `get_all_anc_endpoint_generator()` `get_anc_endpoint_by_id()` `monitor_bulk_status_anc_endpoint()`
	anc_policy	`bulk_request_for_anc_policy()` `create_anc_policy()` `delete_anc_policy_by_id()` `get_all_anc_policy()` `get_anc_policy_by_id()` `get_anc_policy_by_name()` `monitor_bulk_status_anc_policy()` `update_anc_policy_by_id()`
	authentication	`authentication_api()`
	authorization_profile	`create_authorization_profile()` `delete_authorization_profile_by_id()` `get_all_authorization_profiles()` `get_all_authorization_profiles_generator()` `get_authorization_profile_by_id()` `get_authorization_profile_by_name()` `update_authorization_profile_by_id()`
	backup_and_restore	`cancel_backup()` `config_backup()` `get_last_config_backup_status()` `restore_config_backup()` `schedule_config_backup()`
	byod_portal	`create_byod_portal()` `delete_byod_portal_by_id()` `get_all_byod_portal()` `get_all_byod_portal_generator()` `get_byod_portal_by_id()` `update_byod_portal_by_id()`
	certificate_profile	`create_certificate_profile()` `get_all_certificate_profile()` `get_all_certificate_profile_generator()` `get_certificate_profile_by_id()` `get_certificate_profile_by_name()` `update_certificate_profile_by_id()`
	certificate_template	`get_all_certificate_template()` `get_certificate_template_by_id()` `get_certificate_template_by_name()`
	certificates	`bind_csr()` `delete_csr_by_id()` `delete_system_certificate_by_id()` `delete_trusted_certificate_by_id()` `export_csr()` `export_system_cert()` `export_trusted_certificate()` `generate_csr()` `generate_intermediate_ca_csr()` `get_all_system_certificates()` `get_all_system_certificates_generator()` `get_all_trusted_certificates()` `get_all_trusted_certificates_generator()` `get_csr()` `get_csr_by_id()` `get_csr_generator()` `get_system_certificate_by_id()` `get_trusted_certificate_by_id()` `import_system_certificate()` `import_trusted_certificate()` `regenerate_ise_root_ca()` `renew_certificate()` `update_system_certificate()` `update_trusted_certificate()`
	consumer	`access_secret()` `activate_account()` `create_account()` `lookup_service()`
	custom_caller	`add_api()` `call_api()`
	deployment	`get_all_deployment_info()`
	device_administration_authentication_rules	`create_device_admin_authentication_rules()` `delete_device_admin_authentication_rule_by_id()` `get_all_device_admin_authentication_rules()` `get_device_admin_authentication_rule_by_id()` `update_device_admin_authentication_rule_by_id()`
	device_administration_authorization_exception_rules	`create_device_admin_local_exception()` `delete_device_admin_local_exception_by_id()` `get_all_device_admin_local_exception()` `get_device_admin_local_exception_by_id()` `update_device_admin_local_exception_by_id()`
	device_administration_authorization_global_exception_rules	`create_device_admin_policy_set_global_exception()` `delete_device_admin_policyset_global_exception_by_id()` `get_all_device_admin_policy_set_global_exception()` `get_device_admin_policy_set_global_exception_by_id()` `update_device_admin_policyset_global_exception_by_id()`
	device_administration_authorization_rules	`create_device_admin_authorization_rule()` `delete_device_admin_authorization_rule_by_id()` `get_all_device_admin_authorization_rules()` `get_device_admin_authorization_rule_by_id()` `update_device_admin_authorization_rule_by_id()`
	device_administration_command_set	`get_all_device_admin_command_sets()`
	device_administration_conditions	`create_device_admin_condition()` `delete_device_admin_condition_by_id()` `delete_device_admin_condition_by_name()` `get_all_device_admin_conditions()` `get_all_device_admin_conditions_for_authentication_rule()` `get_all_device_admin_conditions_for_authorization_rule()` `get_all_device_admin_conditions_for_policy_set()` `get_device_admin_condition_by_id()` `get_device_admin_condition_by_name()` `update_device_admin_condition_by_id()` `update_device_admin_condition_by_name()`
	device_administration_dictionary_attributes_list	`get_all_device_admin_dictionaries_authentication()` `get_all_device_admin_dictionaries_authorization()` `get_all_device_admin_dictionaries_policyset()`
	device_administration_identity_stores	`get_all_device_admin_identity_stores()`
	device_administration_network_conditions	`create_device_admin_network_condition()` `delete_device_admin_network_condition_by_id()` `get_all_device_admin_network_conditions()` `get_device_admin_network_condition_by_id()` `update_device_admin_network_condition_by_id()`
	device_administration_policy_set	`create_device_admin_policy_set()` `delete_device_admin_policy_set_by_id()` `get_all_device_admin_policy_sets()` `get_device_admin_policy_set_by_id()` `update_device_admin_policy_set_by_id()`
	device_administration_profiles	`get_all_device_admin_profiles()`
	device_administration_service_names	`get_all_device_admin_service_names()`
	device_administration_time_date_conditions	`create_device_admin_time_condition()` `delete_device_admin_time_condition_by_id()` `get_all_device_admin_time_conditions()` `get_device_admin_time_condition_by_id()` `update_device_admin_time_condition_by_id()`
	downloadable_acl	`create_downloadable_acl()` `delete_downloadable_acl_by_id()` `get_all_downloadable_acl()` `get_all_downloadable_acl_generator()` `get_downloadable_acl_by_id()` `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_all_egress_matrix_cell()` `get_all_egress_matrix_cell_generator()` `get_egress_matrix_cell_by_id()` `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_all_endpoints()` `get_all_endpoints_generator()` `get_endpoint_by_id()` `get_endpoint_by_name()` `get_rejected_endpoints()` `monitor_bulk_status_endpoint()` `register_endpoint()` `release_rejected_endpoint()` `update_endpoint_by_id()`
	endpoint_cert	`create_endpoint_certificate()`
	endpoint_group	`create_endpoint_group()` `delete_endpoint_group_by_id()` `get_all_endpoint_groups()` `get_all_endpoint_groups_generator()` `get_endpoint_group_by_id()` `get_endpoint_group_by_name()` `update_endpoint_group_by_id()`
	external_radius_server	`create_external_radius_server()` `delete_external_radius_server_by_id()` `get_all_external_radius_server()` `get_all_external_radius_server_generator()` `get_external_radius_server_by_id()` `get_external_radius_server_by_name()` `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()` `update_filter_policy_by_id()`
	guest_location	`get_all_guest_location()` `get_all_guest_location()` `get_all_guest_location_generator()` `get_guest_location_by_id()`
	guest_smtp_notifications	`create_guest_smtp_notification_settings()` `get_all_guest_smtp_notification_settings()` `get_all_guest_smtp_notification_settings_generator()` `get_guest_smtp_notification_settings_by_id()` `update_guest_smtp_notification_settings_by_id()`
	guest_ssid	`create_guest_ssid()` `delete_guest_ssid_by_id()` `get_all_guest_ssid()` `get_all_guest_ssid_generator()` `get_guest_ssid_by_id()` `update_guest_ssid_by_id()`
	guest_type	`create_guest_type()` `delete_guest_type_by_id()` `get_all_guest_type()` `get_all_guest_type_generator()` `get_guest_type_by_id()` `update_guest_type_email()` `update_guest_type_sms()` `update_guesttype_by_id()`
	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_all_guest_users()` `get_all_guest_users_generator()` `get_guest_user_by_id()` `get_guest_user_by_name()` `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_all_hotspot_portal()` `get_all_hotspot_portal_generator()` `get_hotspot_portal_by_id()` `update_hotspot_portal_by_id()`
	identity_group	`create_identity_group()` `delete_identity_group_by_id()` `get_all_identity_groups()` `get_all_identity_groups_generator()` `get_identity_group_by_id()` `get_identity_group_by_name()` `update_identity_group_by_id()`
	identity_store_sequence	`create_identity_store_sequence()` `delete_identity_store_sequence_by_id()` `get_all_identity_store_sequence()` `get_all_identity_store_sequence_generator()` `get_identity_store_sequence_by_id()` `get_identity_store_sequence_by_name()` `update_identity_store_sequence_by_id()`
	internal_user	`create_internal_user()` `delete_internal_user_by_id()` `delete_internal_user_by_name()` `get_all_internal_user()` `get_all_internal_user_generator()` `get_internal_user_by_name()` `internaluser_by_id()` `update_internal_user_by_id()` `update_internal_user_by_name()`
	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()` `get_all_my_device_portal()` `get_all_my_device_portal_generator()` `get_my_device_portal_by_id()` `update_my_device_portal_by_id()`
	native_supplicant_profile	`delete_native_supplicant_profile_by_id()` `get_all_native_supplicant_profile()` `get_all_native_supplicant_profile_generator()` `get_native_supplicant_profile_by_id()` `update_native_supplicant_profile_by_id()`
	network_access_authentication_rules	`create_network_access_authentication_rule()` `delete_network_access_authentication_rule_by_id()` `get_all_network_access_authentication_rules()` `get_network_access_authentication_rule_by_id()` `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_all_network_access_local_exception_rules()` `get_network_access_local_exception_rule_by_id()` `update_network_access_local_exception_rule_by_id()`
	network_access_authorization_global_exception_rules	`create_network_access_global_exception_rule()` `delete_network_access_global_exception_rule_by_id()` `get_all_network_access_global_exception_rules()` `get_network_access_global_exception_rule_by_id()` `update_network_access_global_exception_rule_by_id()`
	network_access_authorization_rules	`create_network_access_authorization_rule()` `delete_network_access_authorization_rule_by_id()` `get_all_network_access_authorization_rules()` `get_network_access_authorization_rule_by_id()` `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_all_network_access_conditions()` `get_all_network_access_conditions_for_authentication_rules()` `get_all_network_access_conditions_for_authorization_rule()` `get_all_network_access_conditions_for_policy_set()` `get_network_access_condition_by_id()` `get_network_access_condition_by_name()` `update_network_access_condition_by_id()` `update_network_access_condition_by_name()`
	network_access_dictionary	`create_network_access_dictionaries()` `delete_network_access_dictionaries_by_name()` `get_network_access_dictionary_by_name()` `update_network_access_dictionaries_by_name()`
	network_access_dictionary_attribute	`create_network_access_dictionary_attribute_for_dictionary()` `delete_network_access_dictionary_attribute_by_name()` `get_network_access_dictionary_attribute_by_name()` `update_network_access_dictionary_attribute_by_name()`
	network_access_dictionary_attributes_list	`get_all_network_access_dictionaries_authentication()` `get_all_network_access_dictionaries_authorization()` `get_all_network_access_dictionaries_policyset()`
	network_access_identity_stores	`get_all_network_access_identity_stores()`
	network_access_network_conditions	`create_network_access_network_condition()` `delete_network_access_network_condition_by_id()` `get_all_network_access_network_conditions()` `get_network_access_network_condition_by_id()` `update_network_access_network_condition_by_id()`
	network_access_policy_set	`create_network_access_policy_set()` `delete_network_access_policy_set_by_id()` `get_all_network_access_policy_sets()` `get_network_access_policy_set_by_id()` `update_network_access_policy_set_by_id()`
	network_access_profiles	`get_all_network_access_profiles()`
	network_access_security_groups	`get_all_network_access_security_groups()`
	network_access_service_names	`get_all_network_access_service_names()`
	network_access_time_date_conditions	`create_network_access_time_condition()` `delete_network_access_time_condition_by_id()` `get_all_network_access_time_conditions()` `get_network_access_time_condition_by_id()` `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_all_network_device()` `get_all_network_device_generator()` `get_network_device_by_id()` `get_network_device_by_name()` `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_all_network_device_group()` `get_all_network_device_group_generator()` `get_network_device_group_by_id()` `get_network_device_group_by_name()` `update_network_device_group_by_id()`
	node	`get_all_nodes()` `get_all_nodes_generator()` `get_node_by_id()` `get_node_by_name()`
	node_deployment	`delete_node()` `get_all_nodes()` `get_node_details()` `promote_node()` `register_node()` `update_node()`
	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_all_portals()` `get_all_portals()` `get_all_portals_generator()` `get_portal_by_id()`
	portal_global_setting	`get_all_portal_global_settings()` `get_all_portal_global_settings()` `get_all_portal_global_settings_generator()` `get_portal_global_setting_by_id()` `update_portal_global_setting_by_id()`
	portal_theme	`create_portal_theme()` `delete_portal_theme_by_id()` `get_all_portal_themes()` `get_all_portal_themes_generator()` `get_portal_theme_by_id()` `update_portal_theme_by_id()`
	profiler	`get_profiles()`
	profiler_profile	`get_all_profiler_profiles()` `get_all_profiler_profiles_generator()` `get_profiler_profile_by_id()`
	provider	`authorization()` `register_service()` `reregister_service()` `unregister_service()`
	px_grid_node	`approve_px_grid_node()` `delete_px_grid_node_by_name()` `get_all_px_grid_node()` `get_all_px_grid_node_generator()` `get_px_grid_node_by_id()` `get_px_grid_node_by_name()`
	px_grid_settings	`autoapprove_px_grid_node()`
	radius_failure	`get_failures()`
	radius_server_sequence	`create_radius_server_sequence()` `delete_radius_server_sequence_by_id()` `get_all_radius_server_sequence()` `get_all_radius_server_sequence_generator()` `get_radius_server_sequence_by_id()` `update_radius_server_sequence_by_id()`
	replication_status	`get_node_replication_status()`
	repository	`create_repository()` `delete_repository_by_name()` `get_repositories()` `get_repository_by_name()` `get_repository_files()` `update_repository_by_name()`
	restid_store	`create_rest_id_store()` `delete_rest_id_store_by_id()` `delete_rest_id_store_by_name()` `get_all_rest_id_store()` `get_all_rest_id_store_generator()` `get_rest_id_store_by_id()` `get_rest_id_store_by_name()` `update_rest_id_store_by_id()` `update_rest_id_store_by_name()`
	self_registered_portal	`create_self_registered_portal()` `delete_self_registered_portal_by_id()` `get_all_self_registered_portals()` `get_all_self_registered_portals_generator()` `get_self_registered_portal_by_id()` `update_self_registered_portal_by_id()`
	service	`get_all_service()` `get_service_by_name()`
	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()`
	session_service_node	`get_all_session_service_node()` `get_session_service_node_by_id()` `get_session_service_node_by_name()`
	sg_acl	`bulk_request_for_security_groups_acl()` `create_security_groups_acl()` `delete_security_groups_acl_by_id()` `get_all_security_groups_acl()` `get_all_security_groups_acl_generator()` `get_security_groups_acl_by_id()` `monitor_bulk_status_security_groups_acl()` `update_security_groups_acl_by_id()`
	sg_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_all_ip_to_sgt_mapping()` `get_all_ip_to_sgt_mapping_generator()` `get_deploy_status_ip_to_sgt_mapping()` `get_ip_to_sgt_mapping_by_id()` `monitor_bulk_status_ip_to_sgt_mapping()` `update_ip_to_sgt_mapping_by_id()`
	sg_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_all_ip_to_sgt_mapping_group()` `get_all_ip_to_sgt_mapping_group_generator()` `get_deploy_status_ip_to_sgt_mapping_group()` `get_ip_to_sgt_mapping_group_by_id()` `monitor_bulk_status_ip_to_sgt_mapping_group()` `update_ip_to_sgt_mapping_group_by_id()`
	sgt	`bulk_request_for_security_group()` `create_security_group()` `delete_security_group_by_id()` `get_all_security_groups()` `get_all_security_groups_generator()` `get_security_group_by_id()` `monitor_bulk_status_security_group()` `update_security_group_by_id()`
	sgt_vn_vlan	`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_all_security_groups_to_vn_to_vlan()` `get_all_security_groups_to_vn_to_vlan_generator()` `get_security_groups_to_vn_to_vlan_by_id()` `monitor_bulk_status_security_groups_to_vn_to_vlan()` `update_security_groups_to_vn_to_vlan_by_id()`
	sms_provider	`get_all_sms_provider()` `get_all_sms_provider()` `get_all_sms_provider_generator()` `get_sms_provider_by_id()`
	sponsor_group	`create_sponsor_group()` `delete_sponsor_group_by_id()` `get_all_sponsor_group()` `get_all_sponsor_group_generator()` `get_sponsor_group_by_id()` `update_sponsor_group_by_id()`
	sponsor_group_member	`get_all_sponsor_group_member()` `get_all_sponsor_group_member()` `get_all_sponsor_group_member_generator()` `get_sponsor_group_member_by_id()`
	sponsor_portal	`create_sponsor_portal()` `delete_sponsor_portal_by_id()` `get_all_sponsor_portal()` `get_all_sponsor_portal_generator()` `get_sponsor_portal_by_id()` `update_sponsor_portal_by_id()`
	sponsored_guest_portal	`create_sponsored_guest_portal()` `delete_sponsored_guest_portal_by_id()` `get_all_sponsored_guest_portals()` `get_all_sponsored_guest_portals_generator()` `get_sponsored_guest_portal_by_id()` `update_sponsored_guest_portal_by_id()`
	support_bundle	`create_support_bundle()` `download_support_bundle()` `get_all_support_bundle_status()` `get_support_bundle_status_by_id()`
	sxp_connections	`bulk_request_for_sxp_connections()` `create_sxp_connections()` `delete_sxp_connections_by_id()` `get_all_sxp_connections()` `get_all_sxp_connections_generator()` `get_sxp_connections_by_id()` `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_all_sxp_local_bindings()` `get_all_sxp_local_bindings_generator()` `get_sxp_local_bindings_by_id()` `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_all_sxp_vpns()` `get_all_sxp_vpns_generator()` `get_sxp_vpn_by_id()` `monitor_bulk_status_sxp_vpns()`
	sync_ise_node	`sync_node()`
	system_certificate	`create_system_certificate()`
	system_health	`get_healths()` `get_performances()`
	tacacs_command_sets	`create_tacacs_command_sets()` `delete_tacacs_command_sets_by_id()` `get_all_tacacs_command_sets()` `get_tacacs_command_sets_by_id()` `get_tacacs_command_sets_by_name()` `update_tacacs_command_sets_by_id()`
	tacacs_external_servers	`create_tacacs_external_servers()` `delete_tacacs_external_servers_by_id()` `get_all_tacacs_external_servers()` `get_all_tacacs_external_servers_generator()` `get_tacacs_external_servers_by_id()` `get_tacacs_external_servers_by_name()` `update_tacacs_external_servers_by_id()`
	tacacs_profile	`create_tacacs_profile()` `delete_tacacs_profile_by_id()` `get_all_tacacs_profile()` `get_all_tacacs_profile_generator()` `get_tacacs_profile_by_id()` `get_tacacs_profile_by_name()` `update_tacacs_profile_by_id()`
	tacacs_server_sequence	`create_tacacs_server_sequence()` `delete_tacacs_server_sequence_by_id()` `get_all_tacacs_server_sequence()` `get_all_tacacs_server_sequence_generator()` `get_tacacs_server_sequence_by_id()` `get_tacacs_server_sequence_by_name()` `update_tacacs_server_sequence_by_id()`
	tasks	`get_task_status()` `get_task_status_by_id()`
	telemetry_information	`get_all_telemetry_information()` `get_all_telemetry_information_generator()` `get_telemetry_info_by_id()`
	threat	`clear_threats_and_vulnerabilities()`
	trust_sec_configuration	`get_egress_matrices()` `get_egress_policies()` `get_security_group_acls()` `get_security_groups()`
	trust_sec_sxp	`get_bindings()`
	version_	`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_all_aci_bindings(filter_by=None, filter_value=None, page=None, size=None, sort=None, sort_by=None, headers=None, **query_parameters)[source]¶

Get all ACIBindings.

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

ciscoisesdk¶

The User Guide¶

Installation¶

PIP Install¶

PIP Upgrade¶

Get the Source Code¶

Introduction¶

Work with the Identity Services Engine APIs in Native Python!¶

MIT License¶

ciscoisesdk License¶

Quickstart¶

Pass your Identity Services Engine Access Token¶

Set credentials as environment variables¶

Create a IdentityServicesEngineAPI “Connection Object”¶

API Gateway¶

Certificates¶

Package Constants¶

Making API Calls¶

Catching Exceptions¶

Working with Returned Objects¶

Configuring Logging for ciscoisesdk¶

Adding API call definitions¶

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¶

anc_policy¶

active_directory¶

admin_user¶

allowed_protocols¶

authorization_profile¶

byod_portal¶

backup_and_restore¶

certificate_profile¶

certificate_template¶

certificates¶

consumer¶

deployment¶

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¶

endpoint_cert¶

endpoint_group¶

external_radius_server¶

filter_policy¶

guest_location¶

guest_smtp_notifications¶

guest_ssid¶

guest_type¶

guest_user¶

hotspot_portal¶

identity_group¶

identity_store_sequence¶

internal_user¶

mdm¶

misc¶

my_device_portal¶

native_supplicant_profile¶

network_access_authentication_rules¶

network_access_authorization_exception_rules¶

version ¶