Overview

 

Endpoint Identity Groups API allows the client to add, delete, update, and search Endpoint Groups. In this documentation, for each available API you will find the request syntax including the required headers and a response example of a successful flow.

 

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

systemDefined

Boolean

Yes

false


XML example: 

1.  XML
2.  <?xml version="1.0" encoding="UTF-8"?>
3.  <ns0:endpointgroup xmlns:ns0="identity.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="description" id="id" name="name">
4.     <systemDefined>true</systemDefined>
5.  </ns0:endpointgroup>
6.   
7.  JSON
8.  {
9.    "EndPointGroup" : {
10.    "id" : "id",
11.    "name" : "name",
12.    "description" : "description",
13.    "systemDefined" : true
14.  }
15.}





Revision History

 

Revision 0

Resource Version

1.0

ISE Version

1.3

Description

Initial Ise Version

Revision 1

Resource Version

1.1

ISE Version

2.4

Description

Added GetByName operation

Revision Modification

Attribute

Description




Api Reference

Get-By-Name

Request:

Method:

GET

URI:

https://10.56.60.175:9060/ers/config/endpointgroup/name/{name}

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

HTTP 'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI):

fetch


Request Content:

N/A


Response: (EndPointGroup)

HTTP Status:

200 (OK)


Content: 

XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:endpointgroup xmlns:ns0="identity.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="description" id="id" name="name">
   <systemDefined>true</systemDefined>
</ns0:endpointgroup>
 
JSON
{
  "EndPointGroup" : {
    "id" : "id",
    "name" : "name",
    "description" : "description",
    "systemDefined" : true
  }
}

Get-By-Id

Request:

Method:

GET

URI:

https://10.56.60.175:9060/ers/config/endpointgroup/{id}

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

HTTP 'X-CSRF-TOKEN' Header (Required Only if Enabled from GUI):

fetch


Request Content:

N/A


Response: (EndPointGroup)

HTTP Status:

200 (OK)


Content: 

XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:endpointgroup xmlns:ns0="identity.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="description" id="id" name="name">
   <systemDefined>true</systemDefined>
</ns0:endpointgroup>
 
JSON
{
  "EndPointGroup" : {
    "id" : "id",
    "name" : "name",
    "description" : "description",
    "systemDefined" : true
  }
}

Update

Request:

Method:

PUT

URI:

https://10.56.60.175:9060/ers/config/endpointgroup/{id}

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

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:endpointgroup xmlns:ns0="identity.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="description" id="id" name="name">
   <systemDefined>true</systemDefined>
</ns0:endpointgroup>
 
JSON
{
  "EndPointGroup" : {
    "id" : "id",
    "name" : "name",
    "description" : "description",
    "systemDefined" : true
  }
}


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/endpointgroup/{id}

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

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.56.60.175:9060/ers/config/endpointgroup

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

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:endpointgroup xmlns:ns0="identity.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="description" id="id" name="name">
   <systemDefined>true</systemDefined>
</ns0:endpointgroup>
 
JSON
{
  "EndPointGroup" : {
    "id" : "id",
    "name" : "name",
    "description" : "description",
    "systemDefined" : true
  }
}


Response: (N/A)

HTTP Status:

201 (Created)


Content: 

N/A

Get-All

Request:

Method:

GET

URI:

https://10.56.60.175:9060/ers/config/endpointgroup

HTTP 'Content-Type' Header:

application/xml | application/json

HTTP 'Accept' Header:

application/xml | application/json

HTTP 'ERS-Media-Type' Header (Not Mandatory):

identity.endpointgroup.1.1

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"
    }
  }
}

 

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, description]

Get Version

Request:

Method:

GET

URI:

https://10.56.60.175:9060/ers/config/endpointgroup/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"
    }
  }
}