Overview
RestIDStore
API allows clients to add, get, update and delete RestIDStores.
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 |
No |
Resource
UUID, mandatory for update |
|
|
description |
String |
No |
||
|
ersRestIDStoreAttributes |
ErsRestIDStoreAttributes |
Yes |
Holds
the attributes of the restID object. |
|
|
usernameSuffix |
String |
Yes |
Suffix
of the username domain. |
|
|
rootUrl |
String |
Yes |
url of the root of the RestIDStore. |
|
|
predefined |
enum |
Yes |
The
cloud provider connected to of the RestIDStore.
Options are: Azure, Okta, None |
|
|
headers |
ERSRestIDStoreHeader List |
Yes |
headers
for the RestIDStore. |
|
|
key |
String |
Yes |
key of
the header. |
|
|
value |
String |
Yes |
value
of the header |
XML example:
1. XML
2. <?xml version="1.0" encoding="UTF-8"?>
3. <ns0:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" id="29fb45ab-6a8e-4658-8a28-02521c258178" name="RestIdStore1">
4. <ersRestIDStoreAttributes>
5. <headers>
6. <key>tenantID</key>
7. <value>tenantID_value</value>
8. </headers>
9. <headers>
10.
<key>clientID</key>
11.
<value>clientID_value</value>
12.
</headers>
13.
<headers>
14.
<key>clientSecret</key>
15.
<value>clientSecret_value</value>
16.
</headers>
17.
<predefined>Azure</predefined>
18.
<rootUrl>rootUrl</rootUrl>
19.
<usernameSuffix>@place.com</usernameSuffix>
20.
</ersRestIDStoreAttributes>
21.</ns0:ersRestIdStore>
22.
23.JSON
24.{
25.
"ERSRestIDStore" : {
26.
"id" : "29fb45ab-6a8e-4658-8a28-02521c258178",
27.
"name" : "RestIdStore1",
28.
"description" : "Object that represents the restID
store",
29.
"ersRestIDStoreAttributes" : {
30.
"usernameSuffix" : "@place.com",
31.
"rootUrl" : "rootUrl",
32.
"predefined" : "Azure",
33.
"headers" : [ {
34.
"key" : "tenantID",
35.
"value" : "tenantID_value"
36.
}, {
37.
"key" : "clientID",
38.
"value" : "clientID_value"
39.
}, {
40.
"key" : "clientSecret",
41.
"value" : "clientSecret_value"
42.
} ]
43.
}
44.
}
45.}
Revision History
|
Revision 0 |
|
|
Resource
Version |
1.0 |
|
ISE
Version |
3.0 |
|
Description |
Initial
Ise Version |
Api Reference
Top of
Form
Get-By-Name
Request:
|
Method: |
GET |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/name/{name} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.1.0 |
|
HTTP
'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (RestIDStore)
|
HTTP
Status: |
200
(OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" id="29fb45ab-6a8e-4658-8a28-02521c258178" name="RestIdStore1">
<ersRestIDStoreAttributes>
<headers>
<key>tenantID</key>
<value>tenantID_value</value>
</headers>
<headers>
<key>clientID</key>
<value>clientID_value</value>
</headers>
<headers>
<key>clientSecret</key>
<value>clientSecret_value</value>
</headers>
<predefined>Azure</predefined>
<rootUrl>rootUrl</rootUrl>
<usernameSuffix>@place.com</usernameSuffix>
</ersRestIDStoreAttributes>
</ns0:ersRestIdStore>
JSON
{
"ERSRestIDStore" : {
"id" : "29fb45ab-6a8e-4658-8a28-02521c258178",
"name" : "RestIdStore1",
"description" : "Object that represents the restID
store",
"ersRestIDStoreAttributes" : {
"usernameSuffix" : "@place.com",
"rootUrl" : "rootUrl",
"predefined" : "Azure",
"headers" : [ {
"key" : "tenantID",
"value" : "tenantID_value"
}, {
"key" : "clientID",
"value" : "clientID_value"
}, {
"key" : "clientSecret",
"value" : "clientSecret_value"
} ]
}
}
}
Update-By-Name
Request:
|
Method: |
PUT |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/name/{name} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.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:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" id="29fb45ab-6a8e-4658-8a28-02521c258178" name="RestIdStore1">
<ersRestIDStoreAttributes>
<headers>
<key>tenantID</key>
<value>tenantID_value</value>
</headers>
<headers>
<key>clientID</key>
<value>clientID_value</value>
</headers>
<headers>
<key>clientSecret</key>
<value>clientSecret_value</value>
</headers>
<predefined>Azure</predefined>
<rootUrl>rootUrl</rootUrl>
<usernameSuffix>@place.com</usernameSuffix>
</ersRestIDStoreAttributes>
</ns0:ersRestIdStore>
JSON
{
"ERSRestIDStore" : {
"id" : "29fb45ab-6a8e-4658-8a28-02521c258178",
"name" : "RestIdStore1",
"description" : "Object that represents the restID
store",
"ersRestIDStoreAttributes" : {
"usernameSuffix" : "@place.com",
"rootUrl" : "rootUrl",
"predefined" : "Azure",
"headers" : [ {
"key" : "tenantID",
"value" : "tenantID_value"
}, {
"key" : "clientID",
"value" : "clientID_value"
}, {
"key" : "clientSecret",
"value" : "clientSecret_value"
} ]
}
}
}
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-By-Name
Request:
|
Method: |
DELETE |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/name/{name} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.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-By-Id
Request:
|
Method: |
GET |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/{id} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.1.0 |
|
HTTP
'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (RestIDStore)
|
HTTP
Status: |
200
(OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" id="29fb45ab-6a8e-4658-8a28-02521c258178" name="RestIdStore1">
<ersRestIDStoreAttributes>
<headers>
<key>tenantID</key>
<value>tenantID_value</value>
</headers>
<headers>
<key>clientID</key>
<value>clientID_value</value>
</headers>
<headers>
<key>clientSecret</key>
<value>clientSecret_value</value>
</headers>
<predefined>Azure</predefined>
<rootUrl>rootUrl</rootUrl>
<usernameSuffix>@place.com</usernameSuffix>
</ersRestIDStoreAttributes>
</ns0:ersRestIdStore>
JSON
{
"ERSRestIDStore" : {
"id" : "29fb45ab-6a8e-4658-8a28-02521c258178",
"name" : "RestIdStore1",
"description" : "Object that represents the restID
store",
"ersRestIDStoreAttributes" : {
"usernameSuffix" : "@place.com",
"rootUrl" : "rootUrl",
"predefined" : "Azure",
"headers" : [ {
"key" : "tenantID",
"value" : "tenantID_value"
}, {
"key" : "clientID",
"value" : "clientID_value"
}, {
"key" : "clientSecret",
"value" : "clientSecret_value"
} ]
}
}
}
Update
Request:
|
Method: |
PUT |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/{id} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.1.0 |
|
HTTP
'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI): |
The Token value from the GET X-CSRF-TOKEN fetch request |
|
Bulk
Support: |
Operation
'Update' can be used within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" id="29fb45ab-6a8e-4658-8a28-02521c258178" name="RestIdStore1">
<ersRestIDStoreAttributes>
<headers>
<key>tenantID</key>
<value>tenantID_value</value>
</headers>
<headers>
<key>clientID</key>
<value>clientID_value</value>
</headers>
<headers>
<key>clientSecret</key>
<value>clientSecret_value</value>
</headers>
<predefined>Azure</predefined>
<rootUrl>rootUrl</rootUrl>
<usernameSuffix>@place.com</usernameSuffix>
</ersRestIDStoreAttributes>
</ns0:ersRestIdStore>
JSON
{
"ERSRestIDStore" : {
"id" : "29fb45ab-6a8e-4658-8a28-02521c258178",
"name" : "RestIdStore1",
"description" : "Object that represents the restID
store",
"ersRestIDStoreAttributes" : {
"usernameSuffix" : "@place.com",
"rootUrl" : "rootUrl",
"predefined" : "Azure",
"headers" : [ {
"key" : "tenantID",
"value" : "tenantID_value"
}, {
"key" : "clientID",
"value" : "clientID_value"
}, {
"key" : "clientSecret",
"value" : "clientSecret_value"
} ]
}
}
}
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"
} ]
}
}
Get-All
Request:
|
Method: |
GET |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.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">
<link rel="self" href="<url to
resource name1>" type="application/xml"/>
</ns1:resource>
<ns1:resource description="description2" id="id2" name="name2">
<link rel="self" href="<url to
resource name2>" type="application/xml"/>
</ns1:resource>
</ns0:resources>
</ns0:searchResult>
JSON
{
"SearchResult" : {
"total" : 2,
"resources" : [ {
"id" : "id1",
"name" : "name1",
"description" : "description1",
"link" : {
"rel" : "self",
"href" : "<url to resource name1>",
"type" : "application/xml"
}
}, {
"id" : "id2",
"name" : "name2",
"description" : "description2",
"link" : {
"rel" : "self",
"href" : "<url to resource name2>",
"type" : "application/xml"
}
} ],
"nextPage" : {
"rel" : "next",
"href" : "link-to-next-page",
"type" : "application/xml"
},
"previousPage" : {
"rel" : "previous",
"href" : "link-to-previous-page",
"type" : "application/xml"
}
}
}
Supported Filter
and Sorting Fields:
Filter: [name]
To search guest users by using toDate column, please follow the below format:
DD-MON-YY (Ex: 13-SEP-18)
* Day or Year: GET /ers/config/guestuser/?filter=toDate.CONTAINS.13
* Month: GET /ers/config/guestuser/?filter=toDate.CONTAINS.SEP
* Date: GET /ers/config/guestuser/?filter=toDate.CONTAINS.13-SEP-18
Sorting: [name]
Delete
Request:
|
Method: |
DELETE |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/{id} |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.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
Create
Request:
|
Method: |
POST |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' Header: |
application/xml
| application/json |
|
HTTP
'ERS-Media-Type' Header (Not Mandatory): |
identitystores.restidstore.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:ersRestIdStore xmlns:ns0="identitystores.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="Object that represents the restID store" name="RestIdStore1">
<ersRestIDStoreAttributes>
<headers>
<key>tenantID</key>
<value>tenantID_value</value>
</headers>
<headers>
<key>clientID</key>
<value>clientID_value</value>
</headers>
<headers>
<key>clientSecret</key>
<value>clientSecret_value</value>
</headers>
<predefined>Azure</predefined>
<rootUrl>rootUrl</rootUrl>
<usernameSuffix>@place.com</usernameSuffix>
</ersRestIDStoreAttributes>
</ns0:ersRestIdStore>
JSON
{
"ERSRestIDStore": {
"name": "RestIdStore1",
"description": "Object that represents the restID store",
"ersRestIDStoreAttributes": {
"usernameSuffix": "@place.com",
"rootUrl": "rootUrl",
"predefined": "Azure",
"headers": [
{
"key": "tenantID",
"value": "tenantID_value"
},
{
"key": "clientID",
"value": "clientID_value"
},
{
"key": "clientSecret",
"value": "clientSecret_value"
}
]
}
}
}
Response: (RestIDStore)
|
HTTP
Status: |
201
(Created) |
Content:
N/A
Get Version
Request:
|
Method: |
GET |
|
URI: |
https://10.86.189.217:9060/ers/config/restidstore/versioninfo |
|
HTTP
'Content-Type' Header: |
application/xml
| application/json |
|
HTTP
'Accept' 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"
}
}
}
Bottom
of Form