Returns a list of guest users.
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/GuestUsers
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of controller Ids.
Response Parameters
applyGuestUserTo
ApplyGuestUserTo
|
Approach to choose a set of controllers for applying the guest user account.
Allowed values:
CONTROLLER_LIST
INDOOR_AREA
OUTDOOR_AREA
CONFIG_GROUP
|
building
String
|
Name of a building for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA.
|
campus
String
|
Name of a campus for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
configGroup
String
|
Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP.
|
controllerId
Long[]
|
The list of controller IDs containing the guest user.
|
description
String
|
Description of the guest user.
|
disclaimer
String
|
Text with a disclaimer for a guest.
|
endTime
Date
|
An expiry time for the limited guest user. If time is not specified the user is not limited.
|
floor
String
|
Name of a floor for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA. If this field equals "All Floors" the guest account will apply to controllers on all floors.
|
lastModifiedTime
Date
|
The time when the guest user was created or modified in last time.
|
outdoorArea
String
|
Name of an outdoor area for which the guest user is configured. This field using only if applyGuestUserTo equals OUTDOOR_AREA.
|
password
String
|
Password of the guest user. You should use ".case_sensitive=true" if you want to filter by password.
|
profile
String
|
Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value "ANY PROFILE" the guest account will apply to all controllers.
You can use the following API for getting a list of profiles:
/data/WlanProfiles?.full=true&
layer3WebPolicyAuthenticationEnabled=true&
layer3WebPolicyOnMacFailureEnabled=true&.or_filter=true
|
rebootController
boolean
|
Indicates that a controller will be rebooted after applying the guest user.
|
saveConfigToFlash
boolean
|
Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots.
|
status
GuestUserStatus
|
Current status of the guest account.
Allowed values:
ACTIVE
SCHEDULED
NOT_ACTIVE
EXPIRED
|
userRole
String
|
Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value "default" the guest account will apply to all controllers.
You can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller.
|
username
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v1/data/GuestUsers/15
<?xml version="1.0" ?>
<queryResponse type="GuestUsers" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/GuestUsers/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="guestUsersDTO" type="GuestUsers" url="https://localhost/webacs/api/v1/data/GuestUsers/15">
<guestUsersDTO displayName="String value" id="15" uuid="String value">
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<building>String value</building>
<campus>String value</campus>
<configGroup>String value</configGroup>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-04-06T16:39:51.733Z</endTime>
<floor>String value</floor>
<lastModifiedTime>2018-04-06T16:39:51.733Z</lastModifiedTime>
<outdoorArea>String value</outdoorArea>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<status>ACTIVE</status>
<userRole>String value</userRole>
<username>String value</username>
<controllerIds>
<controllerId>15</controllerId>
</controllerIds>
</guestUsersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/GuestUsers/15.json
{
"queryResponse" : {
"@type" : "GuestUsers",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/GuestUsers\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "guestUsersDTO",
"@type" : "GuestUsers",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/GuestUsers\/15",
"guestUsersDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"applyGuestUserTo" : "CONTROLLER_LIST",
"building" : "String value",
"campus" : "String value",
"configGroup" : "String value",
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-04-06T16 : 39 : 51.733Z",
"floor" : "String value",
"lastModifiedTime" : "2018-04-06T16 : 39 : 51.733Z",
"outdoorArea" : "String value",
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"status" : "ACTIVE",
"userRole" : "String value",
"username" : "String value",
"controllerIds" : {
"controllerId" : 15
}
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/data/GuestUsers
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of controller Ids.
Response Parameters
applyGuestUserTo
ApplyGuestUserTo
|
Approach to choose a set of controllers for applying the guest user account.
Allowed values:
CONTROLLER_LIST
INDOOR_AREA
OUTDOOR_AREA
CONFIG_GROUP
|
building
String
|
Name of a building for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA.
|
campus
String
|
Name of a campus for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
configGroup
String
|
Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP.
|
controllerId
Long[]
|
The list of controller IDs containing the guest user.
|
description
String
|
Description of the guest user.
|
disclaimer
String
|
Text with a disclaimer for a guest.
|
endTime
Date
|
An expiry time for the limited guest user. If time is not specified the user is not limited.
|
floor
String
|
Name of a floor for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA. If this field equals "All Floors" the guest account will apply to controllers on all floors.
|
lastModifiedTime
Date
|
The time when the guest user was created or modified in last time.
|
outdoorArea
String
|
Name of an outdoor area for which the guest user is configured. This field using only if applyGuestUserTo equals OUTDOOR_AREA.
|
password
String
|
Password of the guest user. You should use ".case_sensitive=true" if you want to filter by password.
|
profile
String
|
Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value "ANY PROFILE" the guest account will apply to all controllers.
You can use the following API for getting a list of profiles:
/data/WlanProfiles?.full=true&
layer3WebPolicyAuthenticationEnabled=true&
layer3WebPolicyOnMacFailureEnabled=true&.or_filter=true
|
rebootController
boolean
|
Indicates that a controller will be rebooted after applying the guest user.
|
saveConfigToFlash
boolean
|
Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots.
|
status
GuestUserStatus
|
Current status of the guest account.
Allowed values:
ACTIVE
SCHEDULED
NOT_ACTIVE
EXPIRED
|
userRole
String
|
Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value "default" the guest account will apply to all controllers.
You can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller.
|
username
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v2/data/GuestUsers/15
<?xml version="1.0" ?>
<queryResponse type="GuestUsers" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/GuestUsers/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="guestUsersDTO" type="GuestUsers" url="https://localhost/webacs/api/v2/data/GuestUsers/15">
<guestUsersDTO displayName="String value" id="15" uuid="String value">
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<building>String value</building>
<campus>String value</campus>
<configGroup>String value</configGroup>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-04-06T16:39:51.739Z</endTime>
<floor>String value</floor>
<lastModifiedTime>2018-04-06T16:39:51.739Z</lastModifiedTime>
<outdoorArea>String value</outdoorArea>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<status>ACTIVE</status>
<userRole>String value</userRole>
<username>String value</username>
<controllerIds>
<controllerId>15</controllerId>
</controllerIds>
</guestUsersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/GuestUsers/15.json
{
"queryResponse" : {
"@type" : "GuestUsers",
"@requestUrl" : "https://localhost/webacs/api/v2/data/GuestUsers/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "guestUsersDTO",
"@type" : "GuestUsers",
"@url" : "https://localhost/webacs/api/v2/data/GuestUsers/15",
"guestUsersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"applyGuestUserTo" : "CONTROLLER_LIST",
"building" : "String value",
"campus" : "String value",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15 ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : 1523032791739,
"floor" : "String value",
"lastModifiedTime" : 1523032791739,
"outdoorArea" : "String value",
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"status" : "ACTIVE",
"userRole" : "String value",
"username" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/data/GuestUsers
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated in favor of the v4 version, which allows for easier filtering of controller Ids.
Response Parameters
applyGuestUserTo
ApplyGuestUserTo
|
Approach to choose a set of controllers for applying the guest user account.
Allowed values:
CONTROLLER_LIST
INDOOR_AREA
OUTDOOR_AREA
CONFIG_GROUP
|
building
String
|
Name of a building for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA.
|
campus
String
|
Name of a campus for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
configGroup
String
|
Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP.
|
controllerId
Long[]
|
The list of controller IDs containing the guest user.
|
description
String
|
Description of the guest user.
|
disclaimer
String
|
Text with a disclaimer for a guest.
|
endTime
Date
|
An expiry time for the limited guest user. If time is not specified the user is not limited.
|
floor
String
|
Name of a floor for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA. If this field equals "All Floors" the guest account will apply to controllers on all floors.
|
lastModifiedTime
Date
|
The time when the guest user was created or modified in last time.
|
outdoorArea
String
|
Name of an outdoor area for which the guest user is configured. This field using only if applyGuestUserTo equals OUTDOOR_AREA.
|
password
String
|
Password of the guest user. You should use ".case_sensitive=true" if you want to filter by password.
|
profile
String
|
Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value "ANY PROFILE" the guest account will apply to all controllers.
You can use the following API for getting a list of profiles:
/data/WlanProfiles?.full=true&
layer3WebPolicyAuthenticationEnabled=true&
layer3WebPolicyOnMacFailureEnabled=true&.or_filter=true
|
rebootController
boolean
|
Indicates that a controller will be rebooted after applying the guest user.
|
saveConfigToFlash
boolean
|
Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots.
|
status
GuestUserStatus
|
Current status of the guest account.
Allowed values:
ACTIVE
SCHEDULED
NOT_ACTIVE
EXPIRED
|
userRole
String
|
Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value "default" the guest account will apply to all controllers.
You can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller.
|
username
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v3/data/GuestUsers/15
<?xml version="1.0" ?>
<queryResponse type="GuestUsers" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/GuestUsers/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="guestUsersDTO" type="GuestUsers" url="https://localhost/webacs/api/v3/data/GuestUsers/15">
<guestUsersDTO displayName="String value" id="15" uuid="String value">
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<building>String value</building>
<campus>String value</campus>
<configGroup>String value</configGroup>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-04-06T16:39:51.741Z</endTime>
<floor>String value</floor>
<lastModifiedTime>2018-04-06T16:39:51.741Z</lastModifiedTime>
<outdoorArea>String value</outdoorArea>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<status>ACTIVE</status>
<userRole>String value</userRole>
<username>String value</username>
<controllerIds>
<controllerId>15</controllerId>
<controllerId>25</controllerId>
</controllerIds>
</guestUsersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/GuestUsers/15.json
{
"queryResponse" : {
"@type" : "GuestUsers",
"@requestUrl" : "https://localhost/webacs/api/v3/data/GuestUsers/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "guestUsersDTO",
"@type" : "GuestUsers",
"@url" : "https://localhost/webacs/api/v3/data/GuestUsers/15",
"guestUsersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"applyGuestUserTo" : "CONTROLLER_LIST",
"building" : "String value",
"campus" : "String value",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15, 25 ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-04-06T16:39:51.741Z",
"floor" : "String value",
"lastModifiedTime" : "2018-04-06T16:39:51.741Z",
"outdoorArea" : "String value",
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"status" : "ACTIVE",
"userRole" : "String value",
"username" : "String value"
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/data/GuestUsers
Updated
Since version 4 this API uses a ControllerItemDTO collection to represent controller Ids.
Response Parameters
applyGuestUserTo
ApplyGuestUserTo
|
Approach to choose a set of controllers for applying the guest user account.
Allowed values:
CONTROLLER_LIST
INDOOR_AREA
OUTDOOR_AREA
CONFIG_GROUP
|
building
String
|
Name of a building for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA.
|
campus
String
|
Name of a campus for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
configGroup
String
|
Name of a config group for which the guest user is configured. This field using only if applyGuestUserTo equals CONFIG_GROUP.
|
controllerId
ControllerItemDTO[]
|
The list of controller IDs containing the guest user.
|
|
description
String
|
Description of the guest user.
|
disclaimer
String
|
Text with a disclaimer for a guest.
|
endTime
Date
|
An expiry time for the limited guest user. If time is not specified the user is not limited.
|
floor
String
|
Name of a floor for which the guest user is configured. This field using only if applyGuestUserTo equals INDOOR_AREA. If this field equals "All Floors" the guest account will apply to controllers on all floors.
|
lastModifiedTime
Date
|
The time when the guest user was created or modified in last time.
|
outdoorArea
String
|
Name of an outdoor area for which the guest user is configured. This field using only if applyGuestUserTo equals OUTDOOR_AREA.
|
password
String
|
Password of the guest user. You should use ".case_sensitive=true" if you want to filter by password.
|
profile
String
|
Name of a WLAN profile. The guest account will apply only to controllers with an appropriate WLAN profile. If the profile has a value "ANY PROFILE" the guest account will apply to all controllers.
You can use the following API for getting a list of profiles:
/data/WlanProfiles?.full=true&
layer3WebPolicyAuthenticationEnabled=true&
layer3WebPolicyOnMacFailureEnabled=true&.or_filter=true
|
rebootController
boolean
|
Indicates that a controller will be rebooted after applying the guest user.
|
saveConfigToFlash
boolean
|
Indicates that the guest account will be saved to a WLC flash so that account is maintained across WLC reboots.
|
status
GuestUserStatus
|
Current status of the guest account.
Allowed values:
ACTIVE
SCHEDULED
NOT_ACTIVE
EXPIRED
|
userRole
String
|
Name of a local net user role. The guest account will apply only on controllers with an appropriate user role. If the user role has a value "default" the guest account will apply to all controllers.
You can use API data/WlanControllerDetails for getting a list of user roles appropriate for a controller.
|
username
String
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://localhost/webacs/api/v4/data/GuestUsers/15
<?xml version="1.0" ?>
<queryResponse type="GuestUsers" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/GuestUsers/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="guestUsersDTO" type="GuestUsers" url="https://localhost/webacs/api/v4/data/GuestUsers/15">
<guestUsersDTO displayName="String value" id="15" uuid="String value">
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<building>String value</building>
<campus>String value</campus>
<configGroup>String value</configGroup>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-04-06T16:39:51.743Z</endTime>
<floor>String value</floor>
<lastModifiedTime>2018-04-06T16:39:51.743Z</lastModifiedTime>
<outdoorArea>String value</outdoorArea>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<status>ACTIVE</status>
<userRole>String value</userRole>
<username>String value</username>
<controllerIds>
<controllerId>
<id>2</id>
</controllerId>
<controllerId>
<id>12</id>
</controllerId>
</controllerIds>
</guestUsersDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/GuestUsers/15.json
{
"queryResponse" : {
"@type" : "GuestUsers",
"@requestUrl" : "https://localhost/webacs/api/v4/data/GuestUsers/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "guestUsersDTO",
"@type" : "GuestUsers",
"@url" : "https://localhost/webacs/api/v4/data/GuestUsers/15",
"guestUsersDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"applyGuestUserTo" : "CONTROLLER_LIST",
"building" : "String value",
"campus" : "String value",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ {
"id" : 2
}, {
"id" : 12
} ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-04-06T16:39:51.743Z",
"floor" : "String value",
"lastModifiedTime" : "2018-04-06T16:39:51.743Z",
"outdoorArea" : "String value",
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"status" : "ACTIVE",
"userRole" : "String value",
"username" : "String value"
}
} ]
}
}