Overview
Native
supplicant profile API provides the ability to update, delete and search native
supplicant profiles.
Please note that these examples are not meant to
be used as is because they have references to DB data.
You should treat it as a basic template and edit it before sending to server.
Resource definition
|
Attribute |
Type |
Required |
Default
value |
Description |
|
name |
String |
Yes |
Resource name |
|
|
id |
String |
Yes |
Resourse UUID |
|
|
description |
String |
No |
||
|
wirelessProfiles |
WirelessProfileList |
Yes |
List of Wireless profiles |
|
|
ssid |
String |
Yes |
SSID for the wireless profile. |
|
|
allowedProtocol |
enum |
Yes |
Allowed protocol for the wireless profile. Allowed values:
PEAP, TLS, EAP-FAST |
|
|
certificateTemplateId |
String |
No |
Certificate template id |
|
|
actionType |
enum |
Yes |
Action type for WifiProfile. Allowed values: ADD, UPDATE,
DELETE (required for updating existing WirelessProfile) |
|
|
previousSsid |
String |
Yes |
Previous ssid for WifiProfile (required for updating
existing WirelessProfile) |
XML example:
1. XML
2.
<?xml version="1.0" encoding="UTF-8"?>
3. <ns0:nspprofile xmlns:ns0="provisioning.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="ERS
example Native supplicant profile " id="123456789" name="NSPProfile">
4.
<wirelessprofiles>
5. <wirelessprofile>
6.
<actionType>UPDATE</actionType>
7. <allowedprotocol>TLS</allowedprotocol>
8.
<certificateTemplateId>123456789</certificateTemplateId>
9. <previousSsid>ssid1</previousSsid>
10.
<ssid>ssid1</ssid>
11. </wirelessprofile>
12. </wirelessprofiles>
13.</ns0:nspprofile>
14.
15.JSON
16.{
17.
"ERSNSPProfile" : {
18. "id" : "123456789",
19. "name" : "NSPProfile",
20. "description" : "ERS
example Native supplicant profile ",
21. "wirelessProfiles" : [ {
22. "ssid" : "ssid1",
23. "allowedProtocol" : "TLS",
24. "certificateTemplateId" : "123456789",
25. "actionType" : "UPDATE",
26. "previousSsid" : "ssid1"
27. } ]
28. }
29.}
Revision History
|
Revision
0 |
|
|
Resource Version |
1.0 |
|
ISE Version |
2.2 |
|
Description |
Initial Ise Version |
Api Reference
Get-By-Id
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/nspprofile/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
provisioning.nspprofile.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (ERSNSPProfile)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:nspprofile xmlns:ns0="provisioning.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="ERS
example Native supplicant profile " id="123456789" name="NSPProfile">
<wirelessprofiles>
<wirelessprofile>
<actionType>UPDATE</actionType>
<allowedprotocol>TLS</allowedprotocol>
<certificateTemplateId>123456789</certificateTemplateId>
<previousSsid>ssid1</previousSsid>
<ssid>ssid1</ssid>
</wirelessprofile>
</wirelessprofiles>
</ns0:nspprofile>
JSON
{
"ERSNSPProfile" : {
"id" : "123456789",
"name" : "NSPProfile",
"description" : "ERS
example Native supplicant profile ",
"wirelessProfiles" : [ {
"ssid" : "ssid1",
"allowedProtocol" : "TLS",
"certificateTemplateId" : "123456789",
"actionType" : "UPDATE",
"previousSsid" : "ssid1"
} ]
}
}
Update
Request:
|
Method: |
PUT |
|
URI: |
https://10.56.60.175:9060/ers/config/nspprofile/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
provisioning.nspprofile.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
The Token value from
the GET X-CSRF-TOKEN fetch request |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:nspprofile xmlns:ns0="provisioning.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="ERS
example Native supplicant profile " id="123456789" name="NSPProfile">
<wirelessprofiles>
<wirelessprofile>
<actionType>UPDATE</actionType>
<allowedprotocol>TLS</allowedprotocol>
<certificateTemplateId>123456789</certificateTemplateId>
<previousSsid>ssid1</previousSsid>
<ssid>ssid1</ssid>
</wirelessprofile>
</wirelessprofiles>
</ns0:nspprofile>
JSON
{
"ERSNSPProfile" : {
"id" : "123456789",
"name" : "NSPProfile",
"description" : "ERS
example Native supplicant profile ",
"wirelessProfiles" : [ {
"ssid" : "ssid1",
"allowedProtocol" : "TLS",
"certificateTemplateId" : "123456789",
"actionType" : "UPDATE",
"previousSsid" : "ssid1"
} ]
}
}
Response: (UpdatedFieldsList)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:updatedFields xmlns:ns0="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<updatedField
field="field1">
<newValue>val_new</newValue>
<oldValue>val_old</oldValue>
</updatedField>
<updatedField
field="some
other field">
<newValue>val_new</newValue>
<oldValue>val_old</oldValue>
</updatedField>
</ns0:updatedFields>
JSON
{
"UpdatedFieldsList" : {
"updatedField" : [ {
"field" : "field1",
"oldValue" : "val_old",
"newValue" : "val_new"
}, {
"field" : "some other field",
"oldValue" : "val_old",
"newValue" : "val_new"
} ]
}
}
Delete
Request:
|
Method: |
DELETE |
|
URI: |
https://10.56.60.175:9060/ers/config/nspprofile/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
provisioning.nspprofile.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
The Token value from
the GET X-CSRF-TOKEN fetch request |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
Get-All
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/nspprofile |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
provisioning.nspprofile.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (SearchResult)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:searchResult xmlns:ns0="v2.ers.ise.cisco.com" xmlns:ns1="ers.ise.cisco.com" xmlns:ers-v2="ers-v2" total="2">
<ns0:nextPage rel="next" href="link-to-next-page" type="application/xml"/>
<ns0:previousPage rel="previous" href="link-to-previous-page" type="application/xml"/>
<ns0:resources>
<ns1:resource description="description1" id="id1" name="name1"/>
<ns1:resource description="description2" id="id2" name="name2"/>
</ns0:resources>
</ns0:searchResult>
JSON
{
"SearchResult" : {
"total" : 2,
"resources" : [ {
"id" : "id1",
"name" : "name1",
"description" : "description1"
}, {
"id" : "id2",
"name" : "name2",
"description" : "description2"
} ],
"nextPage" : {
"rel" : "next",
"href" : "link-to-next-page",
"type" : "application/xml"
},
"previousPage" : {
"rel" : "previous",
"href" : "link-to-previous-page",
"type" : "application/xml"
}
}
}
Get Version
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/nspprofile/versioninfo |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Response: (Version Info)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:versionInfo xmlns:ns0="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<currentServerVersion>1.0</currentServerVersion>
<link rel="self" href="link" type="application/xml"/>
<supportedVersions>0.9,0.8</supportedVersions>
</ns0:versionInfo>
JSON
{
"VersionInfo" : {
"currentServerVersion" : "1.0",
"supportedVersions" : "0.9,0.8",
"link" : {
"rel" : "self",
"href" : "link",
"type" : "application/xml"
}
}
}