API

This section describes the v1 API of the Device Onboarding application. All of the routes should be prefixed by /v1/.

You can explore the API by visiting the yourserver.domain.com/api/v1.

Authentication is done with a POST request to /api/v1/auth/login, the JSON response will include an access_token key that includes the token needed for additional requests. Store the token in an Authorization header in the HTTP request.

Provided that the value of the token was “123456789”, the authentication header should look like this:

{
    "Authorization": "Bearer 123456789"
}

Endpoints

GET /aaa_group

Get All

Returns a list of all aaa_groups

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].alias (string) – Alias/Friendly name of the aaa_group

  • results[].description (string) – Description of the aaa_group

  • results[].id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • results[].name (string) – Name of the aaa_group (required)

POST /aaa_group

Create AAA group

Creates an aaa_group

Request JSON Object

  • alias (string) – Alias/Friendly name of the aaa_group

  • description (string) – Description of the aaa_group

  • id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • name (string) – Name of the aaa_group (required)

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the aaa_group

  • description (string) – Description of the aaa_group

  • id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • name (string) – Name of the aaa_group (required)

DELETE /aaa_group/{aaa_group_id}

Delete AAA Group

Deletes an aaa_group

Parameters

  • aaa_group_id (integer) –

Status Codes
GET /aaa_group/{aaa_group_id}

Get by ID

Returns a specific aaa_group by its’ id

Parameters

  • aaa_group_id (integer) –

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the aaa_group

  • description (string) – Description of the aaa_group

  • id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • name (string) – Name of the aaa_group (required)

PUT /aaa_group/{aaa_group_id}

Update AAA Group

Updates an aaa group

Parameters

  • aaa_group_id (integer) –

Request JSON Object

  • alias (string) – Alias/Friendly name of the aaa_group

  • description (string) – Description of the aaa_group

  • id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • name (string) – Name of the aaa_group (required)

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the aaa_group

  • description (string) – Description of the aaa_group

  • id (integer) – ID of the aaa_group. Will be generated by the backend (read only)

  • name (string) – Name of the aaa_group (required)

GET /audit

Get All

Returns a list of all audit entries

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].action (string) – The action (verb) of this entry (required, read only)

  • results[].direct_object (any) – The direct object (patiens) of this entry (required, read only)

  • results[].id (integer) – ID of the audit entry. Will be generated by the backend (read only)

  • results[].indirect_object (any) – The indirect object (if any) of this entry (read only)

  • results[].subject (any) – The subject (agens) of this entry (required, read only)

  • results[].timestamp (string) – The timestamp of this entry in ISO8601 format (required, read only)

GET /auth/config

Show Authentication config

Returns information about the authentication config

Status Codes
Response JSON Object

  • default_user_domain (string) – Default LDAP domain to add as as prefix if not specified by users

POST /auth/login

Log In

Authenticates a user, and returns JWT access/refresh tokens

Request JSON Object

  • password (string) – Password of the user logging in (required)

  • username (string) – Name/id of the user logging in (required)

Status Codes
Response JSON Object

  • access_token (string) – The actual JWT access token (required, read only)

  • code (integer) – The HTTP status code returned from the aaa subsystems (required, read only)

  • description (string) – Further details of the result (required, read only)

  • name (string) – A canonical string representation of the status code (required, read only)

  • refresh_token (string) – The actual JWT refresh token (read only)

POST /auth/refresh

Refresh Token

Refreshes a user’s access token, returning a new JWT access token. A valid JWT refresh token must be present in the authorization header

Status Codes
Response JSON Object

  • access_token (string) – The actual JWT access token (required, read only)

  • code (integer) – The HTTP status code returned from the aaa subsystems (required, read only)

  • description (string) – Further details of the result (required, read only)

  • name (string) – A canonical string representation of the status code (required, read only)

  • refresh_token (string) – The actual JWT refresh token (read only)

GET /device

Get All

Returns a list of all devices

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].asset_id (string) – Asset Identifier of the device

  • results[].auths (integer) – The number of authentications this device has performed (read only)

  • results[].created (string) – Date-time string showing when the device was created (read only)

  • results[].created_by (string) – user-id of the user who created this device (read only)

  • results[].description (string) – A descriptive string for the device

  • results[].device_group (string) – The name of the device group this device belongs to

  • results[].device_type (string) – The type or category of the device, an empty string removes the type

  • results[].expires (string) – Date-time string showing when the device expires

  • results[].id (integer) – ID of the device. Will be generated by the backend (read only)

  • results[].idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • results[].ipv4_address (string) – The last seen ip address associated with this device (read only)

  • results[].last_edited (string) – Date-time string showing when the device was last edited (read only)

  • results[].last_edited_by (string) – user-id of the user who last edited this device (read only)

  • results[].last_seen (string) – Date-time string showing when the device was last seen (read only)

  • results[].mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • results[].name (string) – Name of the device

  • results[].nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • results[].nas_ip_address (string) – The IP address of the network authenticator (read only)

  • results[].nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • results[].nas_port_type (string) – The port type / medium for the device (read only)

  • results[].online (boolean) – Boolean flag indicating if this device is online (read only)

  • results[].psk (string) – The PSK for this device

  • results[].pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • results[].quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • results[].verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

POST /device

Create Device

Creates a device

Request JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

Status Codes
Response JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

POST /device/coa/{device_id}

Send CoA

Send a Change of Authorization Request

Parameters

  • device_id (integer) –

Request JSON Object

  • type (string) – The type of CoA to send.

Status Codes
Response JSON Object

  • session_found (boolean) – Indicate if a session for the device was found in ISE.

  • success (boolean) – Indicate if the CoA was successful.

POST /device/import

Import a device that already exists in ISE and update ISE with the required data

Imports a device

Request JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

Status Codes
Response JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

POST /device/import/csv

Submit a CSV file with devices to import

Import devices from a CSV file The headings are the same fields that are used when creating a single device.

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

GET /device/mac/{mac_address}

Get by Mac Address

Returns a a specific device by its mac_address

Parameters

  • mac_address (string) –

Status Codes
Response JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

DELETE /device/purge/{device_id}

Delete Device from the local database but doesn’t touch it in ISE

Purges a device from the database. The operation should only be performed when there are inconsistencies between the portal and ISE.

Parameters

  • device_id (integer) –

Status Codes
DELETE /device/{device_id}

Delete Device

Deletes a device

Parameters

  • device_id (integer) –

Status Codes
GET /device/{device_id}

Get by ID

Returns a a specific device by its’ id

Parameters

  • device_id (integer) –

Status Codes
Response JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

PUT /device/{device_id}

Update Device

Updates a device

Parameters

  • device_id (integer) –

Request JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

Status Codes
Response JSON Object

  • asset_id (string) – Asset Identifier of the device

  • auths (integer) – The number of authentications this device has performed (read only)

  • created (string) – Date-time string showing when the device was created (read only)

  • created_by (string) – user-id of the user who created this device (read only)

  • description (string) – A descriptive string for the device

  • device_group (string) – The name of the device group this device belongs to

  • device_type (string) – The type or category of the device, an empty string removes the type

  • expires (string) – Date-time string showing when the device expires

  • id (integer) – ID of the device. Will be generated by the backend (read only)

  • idle_timeout (integer) – Indicates the number of days since the last_seen timestamp before the device will be quarantined. A value of 0 disables this behaviour.

  • ipv4_address (string) – The last seen ip address associated with this device (read only)

  • last_edited (string) – Date-time string showing when the device was last edited (read only)

  • last_edited_by (string) – user-id of the user who last edited this device (read only)

  • last_seen (string) – Date-time string showing when the device was last seen (read only)

  • mac_address (string) – mac address of this device. E.g.: “00-11-22-33-44-55”

  • name (string) – Name of the device

  • nas_identifier (string) – The NAS identifier of the network authenticator (read only)

  • nas_ip_address (string) – The IP address of the network authenticator (read only)

  • nas_port_id (string) – The port that the device is connected to, or called station for wireless (read only)

  • nas_port_type (string) – The port type / medium for the device (read only)

  • online (boolean) – Boolean flag indicating if this device is online (read only)

  • psk (string) – The PSK for this device

  • pw_type (string) – The password type for the device, can be ‘device’, ‘group’, or ‘mab’

  • quarantine (boolean) – Boolean flag indicating if this device is quarantined

  • verified (boolean) – Indicates if a device has been verified by a user, or bulk imported

GET /device_group

Get All

Returns a list of all device groups

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].aaa_groups[] (string) – The aaa_groups with access to this device_group

  • results[].alias (string) – Alias/Friendly name of the device group

  • results[].created_by (string) – user-id of the user who created this device group (read only)

  • results[].default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • results[].default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • results[].default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • results[].description (string) – A descriptive string for the device group

  • results[].device_count (integer) – The number of devices in this group (read only)

  • results[].id (integer) – ID of the device group. Will be generated by the backend (read only)

  • results[].interface (string) – The interface for this device group

  • results[].last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • results[].name (string) – Name of the device group

  • results[].policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • results[].psk (string) – The PSK for this device group

  • results[].quarantine_interface (string) – The quarantine interface for this device group

  • results[].quarantine_sgt (string) – The quarantine sgt for this device group

  • results[].sgt (string) – The sgt for this device group

  • results[].user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

POST /device_group

Create DeviceGroup

Creates a device group

Request JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

POST /device_group/import

Import a device group that already exists in ISE

Import a device group from ISE

Request JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

POST /device_group/import_devices/{device_group_id}

Import and provision devices from ISE that belong to this group

Import a device group from ISE

Parameters

  • device_group_id (integer) –

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

GET /device_group/name/{device_group_name}

Get by Name

Returns a a specific device group by its’ name

Parameters

  • device_group_name (string) –

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

DELETE /device_group/purge/{device_group_id}

Delete DeviceGroup from the local database but doesn’t touch it in ISE

Purges a device group from the database The operation should only be performed when there are inconsistencies between the portal and ISE.

Parameters

  • device_group_id (integer) –

Status Codes
POST /device_group/quarantine/{device_group_id}

Quarantine all members of this group

Place all the group members in quarantine

Parameters

  • device_group_id (integer) –

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

POST /device_group/sync

Run basic sync check for device groups

Run basic sync check for device groups

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

POST /device_group/sync/members/{device_group_id}

Run basic sync check for device groups members

Run basic sync check for device group members

Parameters

  • device_group_id (integer) –

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

POST /device_group/unquarantine/{device_group_id}

Unquarantine all members of this group

Remove all group members from quarantine

Parameters

  • device_group_id (integer) –

Status Codes
Response JSON Object

  • next_url (string) – The URL where results for the requested task can be collected

  • task_id (string) – The ID of the background task

DELETE /device_group/{device_group_id}

Delete DeviceGroup

Deletes a device group

Parameters

  • device_group_id (integer) –

Status Codes
GET /device_group/{device_group_id}

Get by ID

Returns a a specific device group by its’ id

Parameters

  • device_group_id (integer) –

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

PUT /device_group/{device_group_id}

Update DeviceGroup

Updates a device_group

Parameters

  • device_group_id (integer) –

Request JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • default_idle_timeout (integer) – The default idle timeout (in days) for this device group. 0 = disabled

  • default_pw_type (string) – The default password type for the devices, can be ‘device’, ‘group’, or ‘mab’

  • description (string) – A descriptive string for the device group

  • device_count (integer) – The number of devices in this group (read only)

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • policy_profile (boolean) – Specifies if an unprovisioned authorization profile should be used for this group.

  • psk (string) – The PSK for this device group

  • quarantine_interface (string) – The quarantine interface for this device group

  • quarantine_sgt (string) – The quarantine sgt for this device group

  • sgt (string) – The sgt for this device group

  • user_editable (boolean) – Indicates if non admin users can edit description, psk and default_expiry

GET /device_type

Get All

Returns a list of all device types

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].description (string) – A descriptive string for the device type

  • results[].id (integer) – ID of the device type. Will be generated by the backend (read only)

  • results[].name (string) – Name of the device type

POST /device_type

Create Device Type

Creates a device type

Request JSON Object

  • description (string) – A descriptive string for the device type

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the device type

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the device type

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the device type

DELETE /device_type/{device_type_id}

Delete Device Type

Deletes a device_type

Parameters

  • device_type_id (integer) –

Status Codes
GET /device_type/{device_type_id}

Get by ID

Returns a specific device_type by its id

Parameters

  • device_type_id (integer) –

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the device type

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the device type

PUT /device_type/{device_type_id}

Update Device Type

Updates a device type

Parameters

  • device_type_id (integer) –

Request JSON Object

  • description (string) – A descriptive string for the device type

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the device type

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the device type

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the device type

GET /interface

Get All

Returns a list of all interfaces

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].alias (string) – Alias/Friendly name of the interface

  • results[].description (string) – Description of the interface

  • results[].id (integer) – ID of the interface. Will be generated by the backend (read only)

  • results[].name (string) – Name of the interface (required)

POST /interface

Create Interface

Creates an interface

Request JSON Object

  • alias (string) – Alias/Friendly name of the interface

  • description (string) – Description of the interface

  • id (integer) – ID of the interface. Will be generated by the backend (read only)

  • name (string) – Name of the interface (required)

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the interface

  • description (string) – Description of the interface

  • id (integer) – ID of the interface. Will be generated by the backend (read only)

  • name (string) – Name of the interface (required)

DELETE /interface/{interface_id}

Delete Interface

Deletes an interface

Parameters

  • interface_id (integer) –

Status Codes
GET /interface/{interface_id}

Get by ID

Returns a specific interface by its’ id

Parameters

  • interface_id (integer) –

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the interface

  • description (string) – Description of the interface

  • id (integer) – ID of the interface. Will be generated by the backend (read only)

  • name (string) – Name of the interface (required)

PUT /interface/{interface_id}

Update Interface

Updates an interface

Parameters

  • interface_id (integer) –

Request JSON Object

  • alias (string) – Alias/Friendly name of the interface

  • description (string) – Description of the interface

  • id (integer) – ID of the interface. Will be generated by the backend (read only)

  • name (string) – Name of the interface (required)

Status Codes
Response JSON Object

  • alias (string) – Alias/Friendly name of the interface

  • description (string) – Description of the interface

  • id (integer) – ID of the interface. Will be generated by the backend (read only)

  • name (string) – Name of the interface (required)

GET /ise_device/mac/{mac_address}

Get All

Returns a list of ise device groups

Parameters

  • mac_address (string) –

Status Codes
Response JSON Object

  • description (string) – Description for the device

  • group_id (string) – Unique ID of the group in ISE

  • group_name (string) – Name of the group configured as a custom attribute

  • interface (string) – Name of the interface configured as a custom attribute

  • mac_address (string) – Name of the group

  • psk (string) – The iPSK configured as a custom attribute

GET /ise_device_group

Get All

Returns a list of ise device groups

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].description (string) – Description for the group

  • results[].id (string) – Internal ISE ID of current group

  • results[].name (string) – Name of the group

GET /ise_device_group/name/{group_name}

Get by Name

Returns an ise device groups

Parameters

  • group_name (string) –

Status Codes
Response JSON Object

  • description (string) – Description for the group

  • id (string) – Internal ISE ID of current group

  • name (string) – Name of the group

GET /ise_network_user/name/{user_name}

Get by Network User

Returns a a specific user by its name

Parameters

  • user_name (string) –

Status Codes
Response JSON Object

  • name (string) – Name of the user

GET /ise_sgt

Get All

Returns a list of ise security group tags

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].description (string) – Description for the group

  • results[].id (string) – Internal ISE ID of current group

  • results[].name (string) – Name of the group

GET /ise_sgt/{sgt_id}

Get by ID

Returns an ise sgt

Parameters

  • sgt_id (string) –

Status Codes
Response JSON Object

  • description (string) – Description for the group

  • id (string) – Internal ISE ID of current group

  • name (string) – Name of the group

  • value (integer) – SGT value in integer format

GET /network_group

Get All

Returns a list of all network groups

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].aaa_groups[] (string) – The aaa_groups with access to this device_group

  • results[].alias (string) – Alias/Friendly name of the device group

  • results[].created_by (string) – user-id of the user who created this device group (read only)

  • results[].default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • results[].description (string) – A descriptive string for the device group

  • results[].id (integer) – ID of the device group. Will be generated by the backend (read only)

  • results[].interface (string) – The interface for this device group

  • results[].last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • results[].name (string) – Name of the device group

  • results[].quarantine_interface (string) – The interface for this device group

  • results[].user_count (integer) – The number of users in this group (read only)

POST /network_group

Create NetworkGroup

Creates a network group

Request JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

GET /network_group/name/{group_name}

Get by Network Group

Returns a a specific group by its name

Parameters

  • group_name (string) –

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

DELETE /network_group/purge/{group_id}

Delete NetworkGroup from the local database but doesn’t touch it in ISE

Purges a network group from the database Currently this is the only way to delete a network group as the ISE API doesn’t support deleting identity groups from the API.

Parameters

  • group_id (integer) –

Status Codes
DELETE /network_group/{group_id}

Delete NetworkGroup

Updates a network_group

Parameters

  • group_id (integer) –

Status Codes
GET /network_group/{group_id}

Get by ID

Returns a a specific network group by its id

Parameters

  • group_id (integer) –

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

PUT /network_group/{group_id}

Update DeviceGroup

Updates a network_group

Parameters

  • group_id (integer) –

Request JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

Status Codes
Response JSON Object

  • aaa_groups[] (string) – The aaa_groups with access to this device_group

  • alias (string) – Alias/Friendly name of the device group

  • created_by (string) – user-id of the user who created this device group (read only)

  • default_expiry (integer) – The default expiry (in days) for this device group. 0 = disabled

  • description (string) – A descriptive string for the device group

  • id (integer) – ID of the device group. Will be generated by the backend (read only)

  • interface (string) – The interface for this device group

  • last_edited_by (string) – user-id of the user who last edited this device group (read only)

  • name (string) – Name of the device group

  • quarantine_interface (string) – The interface for this device group

  • user_count (integer) – The number of users in this group (read only)

GET /network_user

Get All

Returns a list of all network users

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].created (string) – Timestamp when this user was created (read only)

  • results[].created_by (string) – user-id of the user who created this network user (read only)

  • results[].description (string) – User description

  • results[].expires (string) – Name of the user

  • results[].id (integer) – ID of the user (read only)

  • results[].last_edited (string) – Timestamp when this user was last edited. (read only)

  • results[].last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • results[].name (string) – Name of the user (required)

  • results[].network_group (string) – Name of the users group (required)

  • results[].password (string) – Password (required)

  • results[].quarantine (boolean) – Boolean flag indicating if this user is quarantined

POST /network_user

Create NetworkUser

Creates a network user

Request JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

Status Codes
Response JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

GET /network_user/name/{user_name}

Get by Network User

Returns a a specific user by its name

Parameters

  • user_name (string) –

Status Codes
Response JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

DELETE /network_user/purge/{user_id}

Delete Network User from the local database but doesn’t touch it in ISE

Purges a network user from the database. The operation should only be performed when there are inconsistencies between the portal and ISE.

Parameters

  • user_id (integer) –

Status Codes
DELETE /network_user/{user_id}

Delete Network User from the system

Deletes a network user

Parameters

  • user_id (integer) –

Status Codes
GET /network_user/{user_id}

Get by ID

Returns a a specific network by its id

Parameters

  • user_id (integer) –

Status Codes
Response JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

PUT /network_user/{user_id}

Update DeviceUser

Updates a network_user

Parameters

  • user_id (integer) –

Request JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

Status Codes
Response JSON Object

  • created (string) – Timestamp when this user was created (read only)

  • created_by (string) – user-id of the user who created this network user (read only)

  • description (string) – User description

  • expires (string) – Name of the user

  • id (integer) – ID of the user (read only)

  • last_edited (string) – Timestamp when this user was last edited. (read only)

  • last_edited_by (string) – user-id of the user who last edited this network user (read only)

  • name (string) – Name of the user (required)

  • network_group (string) – Name of the users group (required)

  • password (string) – Password (required)

  • quarantine (boolean) – Boolean flag indicating if this user is quarantined

GET /sgt

Get All

Returns a list of all SGTs defined in the portal

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].description (string) – A descriptive string for the SGT

  • results[].id (integer) – ID of the device type. Will be generated by the backend (read only)

  • results[].name (string) – Name of the SGT (required)

  • results[].value (integer) – The value of the SGT from ISE (required)

POST /sgt

Create SGT

Creates an SGT in the portal

Request JSON Object

  • description (string) – A descriptive string for the SGT

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the SGT (required)

  • value (integer) – The value of the SGT from ISE (required)

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the SGT

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the SGT (required)

  • value (integer) – The value of the SGT from ISE (required)

DELETE /sgt/{sgt_id}

Delete SGT

Deletes an sgt

Parameters

  • sgt_id (integer) –

Status Codes
GET /sgt/{sgt_id}

Get by ID

Returns a specific sgt by its id

Parameters

  • sgt_id (integer) –

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the SGT

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the SGT (required)

  • value (integer) – The value of the SGT from ISE (required)

PUT /sgt/{sgt_id}

Update SGT

Updates an sgt

Parameters

  • sgt_id (integer) –

Request JSON Object

  • description (string) – A descriptive string for the SGT

  • name (string) – Name of the SGT

  • value (integer) – The value of the SGT from ISE

Status Codes
Response JSON Object

  • description (string) – A descriptive string for the SGT

  • id (integer) – ID of the device type. Will be generated by the backend (read only)

  • name (string) – Name of the SGT (required)

  • value (integer) – The value of the SGT from ISE (required)

GET /status/ise

Get ISE connectivity status

Returns information about ISE connectivity

Status Codes
Response JSON Object

  • ers_api_online (boolean) – Indicates if the ISE ERS API is accessible (read only)

  • mnt_api_online (boolean) – Indicates if the ISE MNT API is accessible (read only)

GET /status/pxgrid

Get pxGrid status

Returns information about the pxGrid

Status Codes
Response JSON Object

  • client_certificate_expiration (string) – The ISO timestamp in UTC when the client certificate for pxGrid expires,will return ‘n/a’ when pxGrid is disabled (read only)

GET /system/config

Get Config

Returns information about api level configurations

Status Codes
Response JSON Object

  • csv_max_import_devices (integer) – Specifies a maximum amount of devices allowed to be imported by CSV in one job. A value of 0 means the feature is disabled

  • customer_logo (string) – Filename of the customer logo to be used in the portal, do not change logo filename using Config API, instead use Logo API

  • default_user_domain (string) – The default LDAP domain to use if not provided by the user at login.

  • device_group_prefix (string) – Device group prefix that will be used from the frontend system

  • display_alias_names (boolean) – Specifies if aliases should be preferred over names for groups and interfaces. This setting only impacts display options in the frontend.

  • end_user_gui (string) – Used to indicate the type of GUI non admin users will use.

  • expiration_enabled (boolean) – Indicates if device expiration is enabled in the configuration

  • generated_psk_forced (boolean) – Inticates if the frontend enforce the use of generated PSKs

  • generated_psk_length (integer) – Shows the length of autogenerated PSKs, a value of 0=disabled

  • idle_timeout_enabled (boolean) – Indicates if device idle timeout is enabled in the configuration

  • max_expiry_days (integer) – Indicates maximum expiry date when creating devices from the frontend.

PUT /system/config

Update Config

Returns information about api level configurations

Request JSON Object

  • csv_max_import_devices (integer) – Specifies a maximum amount of devices allowed to be imported by CSV in one job. A value of 0 means the feature is disabled

  • customer_logo (string) – Filename of the customer logo to be used in the portal, do not change logo filename using Config API, instead use Logo API

  • default_user_domain (string) – The default LDAP domain to use if not provided by the user at login.

  • device_group_prefix (string) – Device group prefix that will be used from the frontend system

  • display_alias_names (boolean) – Specifies if aliases should be preferred over names for groups and interfaces. This setting only impacts display options in the frontend.

  • end_user_gui (string) – Used to indicate the type of GUI non admin users will use.

  • expiration_enabled (boolean) – Indicates if device expiration is enabled in the configuration

  • generated_psk_forced (boolean) – Inticates if the frontend enforce the use of generated PSKs

  • generated_psk_length (integer) – Shows the length of autogenerated PSKs, a value of 0=disabled

  • idle_timeout_enabled (boolean) – Indicates if device idle timeout is enabled in the configuration

  • max_expiry_days (integer) – Indicates maximum expiry date when creating devices from the frontend.

Status Codes
Response JSON Object

  • csv_max_import_devices (integer) – Specifies a maximum amount of devices allowed to be imported by CSV in one job. A value of 0 means the feature is disabled

  • customer_logo (string) – Filename of the customer logo to be used in the portal, do not change logo filename using Config API, instead use Logo API

  • default_user_domain (string) – The default LDAP domain to use if not provided by the user at login.

  • device_group_prefix (string) – Device group prefix that will be used from the frontend system

  • display_alias_names (boolean) – Specifies if aliases should be preferred over names for groups and interfaces. This setting only impacts display options in the frontend.

  • end_user_gui (string) – Used to indicate the type of GUI non admin users will use.

  • expiration_enabled (boolean) – Indicates if device expiration is enabled in the configuration

  • generated_psk_forced (boolean) – Inticates if the frontend enforce the use of generated PSKs

  • generated_psk_length (integer) – Shows the length of autogenerated PSKs, a value of 0=disabled

  • idle_timeout_enabled (boolean) – Indicates if device idle timeout is enabled in the configuration

  • max_expiry_days (integer) – Indicates maximum expiry date when creating devices from the frontend.

GET /system/feature

Get All

Returns information about enabled features

Status Codes
Response JSON Object

  • allow_unprovisioned (boolean) – Specifies if the workflow of onboarding unprovisioned devices is enabled (read only)

  • network_users (boolean) – Indicates if network users (ISE Internal user) handling is enabled (read only)

  • pxgrid_enabled (boolean) – Indicates if pxGrid features are enabled in the configuration (read only)

  • sgt_enabled (boolean) – Specifies if SGT features are enabled for the portal (read only)

GET /system/license

Get license info

Returns information about the license

Status Codes
Response JSON Object

  • customer (string) – Name of the customer, license has been issued too (required, read only)

  • devices (integer) – How many devices (required, read only)

  • expires (string) – Expiration date of the license (required, read only)

  • product (string) – Product name this license covers (required, read only)

Get customer logo

Get current active customer logo or return 204

Status Codes
Response JSON Object

  • content (string) – Base64 encoded string of the asset (required, read only)

  • mimetype (string) – Asset mimetype (required, read only)

  • name (string) – Filename of the asset (required, read only)

Upload customer logo

Upload customer logo, this will also set the logo in config and if already configured, delete previous defined logo

Status Codes
Response JSON Object

  • content (string) – Base64 encoded string of the asset (required, read only)

  • mimetype (string) – Asset mimetype (required, read only)

  • name (string) – Filename of the asset (required, read only)

DELETE /system/logo/{logo_name}

Delete a customer logo

delete logo from asset directory

Parameters

  • logo_name (string) –

Status Codes
GET /system/version

Get All

Returns information about the system versions

Status Codes
Response JSON Object

  • backend (string) – The version of the backend (read only)

  • ise (string) – The version of the ISE server (read only)

GET /task/result/{task_id}

Check status for a background import devices task

Returns status for a background task for importing devices

Parameters

  • task_id (string) –

Status Codes
Response JSON Object

  • progress (integer) – Percentage of the job that is complete

  • results[].entry (string) – The object of the message

  • results[].entry_type (string) – The object type

  • results[].level (string) – The severity level of the message

  • results[].message (string) – The result message

  • status (string) – The status of the job itself

GET /user

Get All

Returns a list of all users. Requires admin privilege

Query Parameters

  • page (string) – Page number for pagination

  • page_size (string) – Number of entries per page

Status Codes
Response JSON Object

  • _meta.page (integer) – The current page [for pagination]

  • _meta.page_size (integer) – Page size (max: 100)

  • _meta.total_items (integer) – total number of items

  • results[].current_login (string) – Date-time string showing when the device was last seen (read only)

  • results[].id (integer) – ID of the user. Will be generated by the backend (read only)

  • results[].previous_login (string) – Date-time string showing when the device was last seen (read only)

  • results[].ui_settings (string) – JSON string used by the frontend to control UI Settings

  • results[].user_id (string) – The ‘user_id’ (principal name) property of the user (read only)

GET /user/current_user

Get Current User

Returns the current (token) user.

Status Codes
Response JSON Object

  • current_login (string) – Date-time string showing when the device was last seen (read only)

  • id (integer) – ID of the user. Will be generated by the backend (read only)

  • previous_login (string) – Date-time string showing when the device was last seen (read only)

  • ui_settings (string) – JSON string used by the frontend to control UI Settings

  • user_id (string) – The ‘user_id’ (principal name) property of the user (read only)

PUT /user/current_user

Update Current User

Updates the current user

Request JSON Object

  • current_login (string) – Date-time string showing when the device was last seen (read only)

  • id (integer) – ID of the user. Will be generated by the backend (read only)

  • previous_login (string) – Date-time string showing when the device was last seen (read only)

  • ui_settings (string) – JSON string used by the frontend to control UI Settings

  • user_id (string) – The ‘user_id’ (principal name) property of the user (read only)

Status Codes
Response JSON Object

  • current_login (string) – Date-time string showing when the device was last seen (read only)

  • id (integer) – ID of the user. Will be generated by the backend (read only)

  • previous_login (string) – Date-time string showing when the device was last seen (read only)

  • ui_settings (string) – JSON string used by the frontend to control UI Settings

  • user_id (string) – The ‘user_id’ (principal name) property of the user (read only)