Cisco Identity Services Engine
The Cisco Identity Services Engine(ISE) connector integrates with Swimlane Turbine. This Connector gives Cisco Identity Services Engine(ISE) Admin the power to integrate with ISE MNT Monitoring (MNT) RESTAPI and allow you to retrieve active and historic RADIUS session details.
Prerequisites
You must have administrator rights and know your URL, username, password in order to utilize this connector.
Capabilities
This connector provides the following capabilities:
Session Management
- Get Active Sessions Counter
- Get Active Session Lists
Real-Time Monitoring and Alerting
- Get MAC Address Session Search
- Get Authenticated Sessions List
- Get Profiler Sessions Counter
Automated Response for Unauthorized Access
CoA session management API calls allow you to send reauthentication and disconnect commands to a specified session on a target Cisco Monitoring ISE node in your Cisco ISE deployment.
- Change of Authorization Session Disconnect
- Change of Authorization Session Reauthentication
Additional Session Attributes for Enhanced Security
- Get NAS IP Address Session Search
Task Setup
- Get Authenticated Sessions List Values for starttime and endtime path_parameters:
- null/null : Lists all active authenticated sessions.
- null/endtime : Lists all active authenticated sessions after the specified end time.
- starttime/null : Lists all active authenticated sessions before the specified start time.
- starttime/endtime : Lists all active authenticated sessions between the specified start time and end time.
Notes
- For more information on Cisco Identity Services Engine(ISE):
Configurations
Cisco ISE HTTP Basic Authentication
Authenticates using username and password.
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | Cisco ISE URL in the address bar of your browser (for example, https:// ο»Ώ | string | Required |
username | Username | string | Required |
password | Password | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Change of Authorization Session Disconnect
CoA session management API calls allow you to send disconnect commands to a specified session on a target Cisco Monitoring ISE node in your Cisco ISE deployment.
Endpoint
- URL: /admin/API/mnt/CoA/Disconnect/{{PSN_NAME}}/{{MAC}}/{{DISCONNECT}}/{{NAD_IP}}/{{ENDPOINT_IP}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.PSN_NAME | string | Required | Parameters for the Change of Authorization Session Disconnect action |
path_parameters.MAC | string | Required | Parameters for the Change of Authorization Session Disconnect action |
path_parameters.DISCONNECT | number | Required | Values 0, 1, 2 in the reference of DYNAMIC_AUTHZ_PORT_DEFAULT = 0, DYNAMIC_AUTHZ_PORT_BOUNCE = 1, DYNAMIC_AUTHZ_PORT_SHUTDOWN = 2. |
path_parameters.NAD_IP | string | Required | Parameters for the Change of Authorization Session Disconnect action |
path_parameters.ENDPOINT_IP | string | Required | Parameters for the Change of Authorization Session Disconnect action |
Input Example
{"path_parameters":{"PSN_NAME":"ise","MAC":"BA:4B:FB:77:B8:BF","DISCONNECT":0,"NAD_IP":"10.80.60.150","ENDPOINT_IP":"10.251.204.55"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Change of Authorization Session Reauthentication
CoA session management API calls allow you to send reauthentication command to a specified session on a target Cisco Monitoring ISE node in your Cisco ISE deployment.
Endpoint
- URL: /admin/API/mnt/CoA/Reauth/{{PSN_NAME}}/{{MAC}}/{{REAUTH_TYPE}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.PSN_NAME | string | Required | Parameters for the Change of Authorization Session Reauthentication action |
path_parameters.MAC | string | Required | Parameters for the Change of Authorization Session Reauthentication action |
path_parameters.REAUTH_TYPE | number | Required | Values 0, 1, 2 in the reference of REAUTH_TYPE_DEFAULT = 0, REAUTH_TYPE_LAST = 1, REAUTH_TYPE_RERUN = 2. |
Input Example
{"path_parameters":{"PSN_NAME":"ise","MAC":"BA:4B:FB:77:B8:BF","REAUTH_TYPE":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Active Session Lists
Get a list of all active RADIUS sessions, including new MAC addresses.
Endpoint
- URL: /admin/API/mnt/Session/ActiveList
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Active Sessions Counter
Retrieve the count of active sessions.
Endpoint
- URL: /admin/API/mnt/Session/ActiveCount
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Authenticated Sessions List
Get a list of all authenticated sessions between start and end timestamps.
Endpoint
- URL: /admin/API/mnt/Session/AuthList/{{starttime}}/{{endtime}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.starttime | string | Required | Start Time should be in the format of YYYY-MM-DD hh:mm:ss.s. |
path_parameters.endtime | string | Required | End Time should be in the format of YYYY-MM-DD hh:mm:ss.s. |
Input Example
{"path_parameters":{"starttime":"2020.07.29 12:12:12.123","endtime":"2022.07.29 12:12:12.123"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get MAC Address Session Search
Get the active RADIUS session for the specified MAC address.
Endpoint
- URL: /admin/admin/API/mnt/Session/MACAddress/{{macaddress}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.macaddress | string | Required | Must use this MAC address format XX:XX:XX:XX:XX:XX. |
Input Example
{"path_parameters":{"macaddress":"BA:4B:FB:77:B8:BF"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get NAS IP Address Session Search
Get a list of all active RADIUS sessions for the specified network access device (NAD) NAS IP address. IPV4 or IPV6 address is allowed.
Endpoint
- URL: /admin/API/mnt/Session/IPAddress/{{NAD_IP}}
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.NAD_IP | string | Required | IPv4 (n.n.n.n) or IPv6 (xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx) address is allowed. |
Input Example
{"path_parameters":{"NAD_IP":"10.80.60.151"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Profiler Sessions Counter
Count of active Profiler service sessions, useful for detecting new devices on the network. Use the ProfilerCount API call to retrieve a count of all currently active sessions using profilng.
Endpoint
- URL: /admin/API/mnt/Session/ProfilerCount
- Method: GET
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |