Overview
Guest
User API allows the client to add, delete, update and search Guest Users among
other Operation which are available from the Sponsor Portal. 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 each API description shows weather the API is supported in
bulk operation. The Bulk section is showing only 'create' bulk operation
however, all other operation which are bulk supported can be used in same way.
Known Caveats with Cisco ISE Guest API
If you try to do any CRUD operations (Create, Read, Update, Delete) with the Cisco ISE guest APIs, you are likely receive an HTTP Status 401 – Unauthorized error message. This is a known issue:
CSCvd48557 - Ability to set the sponsor user with the guest API
The only way to create, read, update or delete guest users is with a sponsor account. When you create a guest account it sets the sponsor user to that of the sponsor calling the API. There is no way to override this. For
more information, see Known Caveats with Cisco ISE Guest API.
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 |
||
|
customFields |
Map |
No |
Key value map |
|
|
guestType |
String |
No |
||
|
status |
String |
No |
||
|
reasonForVisit |
String |
No |
||
|
personBeingVisited |
String |
No |
||
|
sponsorUserName |
String |
No |
||
|
sponsorUserId |
String |
No |
||
|
statusReason |
String |
No |
||
|
portalId |
String |
No |
||
|
guestAccessInfo |
GuestInfo |
No |
||
|
- validDays |
Int |
Yes |
-1 |
Number of days guest user is valid |
|
- fromDate |
String |
No |
||
|
- toDate |
String |
No |
||
|
- location |
String |
No |
||
|
- ssid |
String |
No |
||
|
- groupTag |
String |
No |
||
|
GuestInfo |
GuestInfo |
Yes |
||
|
- emailAddress |
String |
No |
||
|
- enabled |
Boolean |
Yes |
false |
This field is only for Get
operation not applicable for Create, Update operations. |
|
- password |
String |
Yes |
||
|
- phoneNumber |
String |
No |
||
|
- smsServiceProvider |
String |
No |
||
|
- userName |
String |
No |
||
|
- firstName |
String |
No |
||
|
- lastName |
String |
No |
||
|
- company |
String |
No |
||
|
- creationTime |
String |
No |
||
|
- notificationLanguage |
String |
No |
XML example:
1. XML
2.
<?xml version="1.0" encoding="UTF-8"?>
3. <ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
4.
<customFields>
5. <entry>
6.
<key>another key</key>
7. <value>and its value</value>
8.
</entry>
9. <entry>
10. <key>some key</key>
11. <value>some value</value>
12. </entry>
13. </customFields>
14. <guestAccessInfo>
15. <fromDate>07/29/2014 14:44</fromDate>
16. <location>San Jose</location>
17. <toDate>10/29/2014 17:30</toDate>
18. <validDays>90</validDays>
19. </guestAccessInfo>
20. <guestInfo>
21. <emailAddress>email@some.uri.com</emailAddress>
22. <enabled>true</enabled>
23. <password>asdlkj324ew</password>
24. <phoneNumber>3211239034</phoneNumber>
25. <smsServiceProvider>GLobal Default</smsServiceProvider>
26. <userName>DS3ewdsa34wWE</userName>
27. </guestInfo>
28. <guestType>Contractor</guestType>
29. <portalId>23423432523</portalId>
30. <sponsorUserName>Mr Spons</sponsorUserName>
31.</ns0:guestuser>
32.
33.JSON
34.{
35. "GuestUser" : {
36. "id" : "123456789",
37. "name" : "guestUser",
38. "description"
:
"ERS Example user ",
39. "guestType" : "Contractor",
40. "sponsorUserName"
:
"Mr Spons",
41. "guestInfo" : {
42. "userName"
:
"DS3ewdsa34wWE",
43. "emailAddress" : "email@some.uri.com",
44. "phoneNumber"
:
"3211239034",
45. "password" : "asdlkj324ew",
46. "enabled"
:
true,
47. "smsServiceProvider" : "GLobal
Default"
48. },
49. "guestAccessInfo" : {
50. "validDays"
:
90,
51. "fromDate" : "07/29/2014
14:44",
52. "toDate"
:
"10/29/2014 17:30",
53. "location" : "San Jose"
54. },
55. "portalId" : "23423432523",
56. "customFields"
:
{
57. "another
key" : "and its value",
58. "some key"
:
"some value"
59. }
60. }
61.}
Revision History
|
Revision
0 |
|||
|
Resource Version |
1.0 |
||
|
ISE Version |
1.2 |
||
|
Description |
Initial Ise Version |
||
|
Revision
1 |
|||
|
Resource Version |
2.0 |
||
|
ISE Version |
1.3 |
||
|
Description |
Introducing new schema - not
supporting 1.0 anymore. |
||
|
Revision Modification |
|
||
Api
Reference
Top of Form
Get-By-Name
Request:
|
Method: |
GET |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/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.guestuser.2.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (GuestUser)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
<customFields>
<entry>
<key>another key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns0:guestuser>
JSON
{
"GuestUser" : {
"id" : "123456789",
"name" : "guestUser",
"description" : "ERS Example user
",
"guestType" : "Contractor",
"sponsorUserName" : "Mr Spons",
"guestInfo" : {
"userName" : "DS3ewdsa34wWE",
"emailAddress" : "email@some.uri.com",
"phoneNumber" : "3211239034",
"password" : "asdlkj324ew",
"enabled" : true,
"smsServiceProvider" : "GLobal
Default"
},
"guestAccessInfo" : {
"validDays" : 90,
"fromDate" : "07/29/2014
14:44",
"toDate" : "10/29/2014
17:30",
"location" : "San Jose"
},
"portalId" : "23423432523",
"customFields" : {
"another
key" : "and its value",
"some
key" : "some value"
}
}
}
deny
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/deny/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'deny' can be used
within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
sms
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/sms/{id}/portalId/{portalId} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'sms' can be used within
Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
approve
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/approve/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'approve' can be used
within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
DeleteByName
Request:
|
Method: |
DELETE |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/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.guestuser.2.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 'DeleteByName' can be
used within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/email/{id}/portalId/{portalId} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'email' can be used
within Bulk Request. |
|
Additional Attributes: |
senderEmail |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:operationAdditionalData xmlns:ns0="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<requestAdditionalAttributes>
<additionalAttribute name="senderEmail"
value="value_0"/>
</requestAdditionalAttributes>
</ns0:operationAdditionalData>
JSON
{
"OperationAdditionalData" : {
"additionalData" : [ {
"name" : "example
additional attribute name",
"value" : "its value"
} ]
}
}
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
reinstateById
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/reinstate/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'reinstateById' can be
used within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
reinstateByName
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/reinstate/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.guestuser.2.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 'reinstateByName' can be
used within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
resetpassword
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/resetpassword/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'resetpassword' can be
used within Bulk Request. |
Request Content:
N/A
Response: (OperationResult)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:operationResult xmlns:ns0="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<attributesList>
<attribute name="password"
value="DdsAASDs%$##@ssds12"/>
</attributesList>
</ns0:operationResult>
JSON
{
"OperationResult" : {
"resultValue" : [ {
"value" : "DdsAASDs%$##@ssds12",
"name" : "password"
} ]
}
}
UpdateByName
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/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.guestuser.2.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 'UpdateByName' can be
used within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
<customFields>
<entry>
<key>another key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns0:guestuser>
JSON
{
"GuestUser" : {
"id" : "123456789",
"name" : "guestUser",
"description" : "ERS Example user
",
"guestType" : "Contractor",
"sponsorUserName" : "Mr Spons",
"guestInfo" : {
"userName" : "DS3ewdsa34wWE",
"emailAddress" : "email@some.uri.com",
"phoneNumber" : "3211239034",
"password" : "asdlkj324ew",
"enabled" : true,
"smsServiceProvider" : "GLobal
Default"
},
"guestAccessInfo"
:
{
"validDays" : 90,
"fromDate" : "07/29/2014
14:44",
"toDate" : "10/29/2014
17:30",
"location" : "San Jose"
},
"portalId" : "23423432523",
"customFields" : {
"another
key" : "and its value",
"some key"
:
"some 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"
} ]
}
}
changeSponsorPassword
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/changeSponsorPassword/{portalId} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'changeSponsorPassword'
can be used within Bulk Request. |
|
Additional Attributes: |
currentPassword, newPassword |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:operationAdditionalData xmlns:ns0="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<requestAdditionalAttributes>
<additionalAttribute name="currentPassword"
value="value_0"/>
<additionalAttribute name="newPassword"
value="value_1"/>
</requestAdditionalAttributes>
</ns0:operationAdditionalData>
JSON
{
"OperationAdditionalData" : {
"additionalData" : [ {
"name" : "example
additional attribute name",
"value" : "its value"
} ]
}
}
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
suspendByName
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/suspend/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.guestuser.2.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 'suspendByName' can be
used within Bulk 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.105.171.77:9060/ers/config/guestuser/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (GuestUser)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
<customFields>
<entry>
<key>another key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns0:guestuser>
JSON
{
"GuestUser" : {
"id" : "123456789",
"name" : "guestUser",
"description" : "ERS Example user
",
"guestType" : "Contractor",
"sponsorUserName" : "Mr Spons",
"guestInfo" : {
"userName" : "DS3ewdsa34wWE",
"emailAddress" : "email@some.uri.com",
"phoneNumber" : "3211239034",
"password" : "asdlkj324ew",
"enabled" : true,
"smsServiceProvider" : "GLobal
Default"
},
"guestAccessInfo" : {
"validDays" : 90,
"fromDate" : "07/29/2014
14:44",
"toDate" : "10/29/2014
17:30",
"location" : "San Jose"
},
"portalId" : "23423432523",
"customFields"
:
{
"another
key" : "and its value",
"some
key" : "some value"
}
}
}
UpdateById
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'UpdateById' can be used
within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
<customFields>
<entry>
<key>another key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns0:guestuser>
JSON
{
"GuestUser" : {
"id" : "123456789",
"name" : "guestUser",
"description" : "ERS Example user
",
"guestType" : "Contractor",
"sponsorUserName" : "Mr Spons",
"guestInfo" : {
"userName" : "DS3ewdsa34wWE",
"emailAddress" : "email@some.uri.com",
"phoneNumber" : "3211239034",
"password" : "asdlkj324ew",
"enabled" : true,
"smsServiceProvider" : "GLobal
Default"
},
"guestAccessInfo" : {
"validDays" : 90,
"fromDate" : "07/29/2014
14:44",
"toDate" : "10/29/2014
17:30",
"location" : "San Jose"
},
"portalId" : "23423432523",
"customFields" : {
"another
key" : "and its value",
"some
key" : "some 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"
} ]
}
}
DeleteById
Request:
|
Method: |
DELETE |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'DeleteById' can be used
within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
Create
Request:
|
Method: |
POST |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'Create' can be used
within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:guestuser 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="ERS Example user "
id="123456789" name="guestUser">
<customFields>
<entry>
<key>another key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns0:guestuser>
JSON
{
"GuestUser" : {
"id" : "123456789",
"name" : "guestUser",
"description" : "ERS Example user
",
"guestType" : "Contractor",
"sponsorUserName" : "Mr Spons",
"guestInfo" : {
"userName" : "DS3ewdsa34wWE",
"emailAddress" : "email@some.uri.com",
"phoneNumber" : "3211239034",
"password" : "asdlkj324ew",
"enabled" : true,
"smsServiceProvider" : "GLobal
Default"
},
"guestAccessInfo" : {
"validDays" : 90,
"fromDate" : "07/29/2014
14:44",
"toDate" : "10/29/2014
17:30",
"location" : "San Jose"
},
"portalId" : "23423432523",
"customFields" : {
"another
key" : "and its value",
"some
key" : "some value"
}
}
}
Response: (N/A)
|
HTTP Status: |
201 (Created) |
Content:
N/A
suspendById
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/suspend/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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 'suspendById' can be
used within Bulk Request. |
|
Additional Attributes: |
reason |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:operationAdditionalData xmlns:ns0="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<requestAdditionalAttributes>
<additionalAttribute name="reason"
value="value_0"/>
</requestAdditionalAttributes>
</ns0:operationAdditionalData>
JSON
{
"OperationAdditionalData" : {
"additionalData" : [ {
"name" : "example
additional attribute name",
"value" : "its value"
} ]
}
}
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
Get-All
Request:
|
Method: |
GET |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
identity.guestuser.2.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"
}
}
}
Supported
Filter and Sorting Fields:
Filter: [lastName, sponsor, creationTime, personBeingVisited, toDate, userName, firstName, emailAddress, phoneNumber, groupTag, name, company, guestType, status]
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: [firstName, lastName, emailAddress, name, description]
Get Version
Request:
|
Method: |
GET |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/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"
}
}
}
Bulk Request
Request:
|
Method: |
PUT |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/bulk/submit |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:guestUserBulkRequest operationType="create" resourceMediaType="vnd.com.cisco.ise.identity.guestuser.2.0+xml" xmlns:ns6="sxp.ers.ise.cisco.com" xmlns:ns5="trustsec.ers.ise.cisco.com" xmlns:ns8="network.ers.ise.cisco.com" xmlns:ns7="anc.ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns4="identity.ers.ise.cisco.com">
<ns4:resourcesList>
<ns4:guestuser description="ERS Example user 1" id="1234567891"
name="guestUser1">
<customFields>
<entry>
<key>another
key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns4:guestuser>
<ns4:guestuser description="ERS Example user 2" id="1234567892"
name="guestUser2">
<customFields>
<entry>
<key>another
key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns4:guestuser>
<ns4:guestuser description="ERS Example user 3" id="1234567893"
name="guestUser3">
<customFields>
<entry>
<key>another
key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns4:guestuser>
<ns4:guestuser description="ERS Example user 4" id="1234567894"
name="guestUser4">
<customFields>
<entry>
<key>another
key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns4:guestuser>
<ns4:guestuser description="ERS Example user 5" id="1234567895"
name="guestUser5">
<customFields>
<entry>
<key>another
key</key>
<value>and its value</value>
</entry>
<entry>
<key>some key</key>
<value>some value</value>
</entry>
</customFields>
<guestAccessInfo>
<fromDate>07/29/2014 14:44</fromDate>
<location>San Jose</location>
<toDate>10/29/2014 17:30</toDate>
<validDays>90</validDays>
</guestAccessInfo>
<guestInfo>
<emailAddress>email@some.uri.com</emailAddress>
<enabled>true</enabled>
<password>asdlkj324ew</password>
<phoneNumber>3211239034</phoneNumber>
<smsServiceProvider>GLobal Default</smsServiceProvider>
<userName>DS3ewdsa34wWE</userName>
</guestInfo>
<guestType>Contractor</guestType>
<portalId>23423432523</portalId>
<sponsorUserName>Mr Spons</sponsorUserName>
</ns4:guestuser>
</ns4:resourcesList>
</ns4:guestUserBulkRequest>
JSON
{
"GuestUserBulkRequest" : {
"operationType" : "create",
"resourceMediaType" : "vnd.com.cisco.ise.identity.guestuser.2.0+xml"
}
}
Response:
|
HTTP Status: |
202 (Accepted) |
Content:
N/A
Monitor Bulk Status
Request:
|
Method: |
GET |
|
URI: |
https://10.105.171.77:9060/ers/config/guestuser/bulk/{bulkid} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Request Content:
N/A
Response:
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:bulkStatus xmlns:ns0="ers.ise.cisco.com"
xmlns:xs="http://www.w3.org/2001/XMLSchema" bulkId="1553858840443"
executionStatus="COMPLETED"
failCount="0" mediaType="" operationType="create"
resourcesCount="5" startTime="Fri Mar 29
16:57:20 IST 2019" successCount="5">
<ns0:resourcesStatus>
<ns0:resourceStatus description="description..."
id="1234454324" name="resource1"
status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus description="description..."
id="2343242342" name="resource2"
status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus description="description..."
id="4564566456" name="resource3"
status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus description="description..."
id="6544566455" name="resource4"
status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
</ns0:resourcesStatus>
</ns0:bulkStatus>
JSON
{
"BulkStatus" : {
"bulkId" : "1553858840443",
"mediaType" : "",
"executionStatus" : "COMPLETED",
"operationType" : "create",
"startTime" : "Fri Mar 29 16:57:20
IST 2019",
"resourcesCount" : 5,
"successCount" : 5,
"failCount" : 0,
"resourcesStatus" : [ {
"id" : "1234454324",
"name" : "resource1",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "2343242342",
"name" : "resource2",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "4564566456",
"name" : "resource3",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "6544566455",
"name" : "resource4",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
} ]
}
}
Bottom of Form