Creates a new guest user.
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
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/op/guestUser
Request Payload 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
|
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 for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.
|
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.
|
locationGroupId
Long
|
ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
password
String
|
Password of the guest user.
|
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.
|
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
|
|
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
|
results
GuestUserOperationResultDTO[]
|
The result of the operation on a certain WLAN controller.
|
controllerName
String
|
The name of a controller.
|
ipAddress
InetAddress
|
The IP address of a controller.
|
operationStatus
GuestUserOperationStatus
|
The status of applying a guest account to a controller.
Allowed values:
- NOT_ATTEMPTED
- REJECTED
- FAILURE
- PARTIAL_FAILURE
- SUCCESS
|
reason
String
|
The info about a failure reason.
|
|
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 Request Payload
https://localhost/webacs/api/v1/op/guestUser
<?xml version="1.0" ?>
<manageGuestUsersDTO>
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<configGroup>String value</configGroup>
<controllerIds>
<controllerId>15</controllerId>
</controllerIds>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-12-21T12:09:31.733+07:00</endTime>
<locationGroupId>15</locationGroupId>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<userRole>String value</userRole>
<username>String value</username>
</manageGuestUsersDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/guestUser.json
{
"manageGuestUsersDTO" : {
"applyGuestUserTo" : "CONTROLLER_LIST",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : 15
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-12-21T12 : 09 : 31.733+07 : 00",
"locationGroupId" : 15,
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"userRole" : "String value",
"username" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/guestUser
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/guestUser" rootUrl="https://localhost/webacs/api/v1/op">
<guestUserOperationResultsDTO>
<operationType>CREATE</operationType>
<operationResults>
<operationResult>
<controllerName>String value</controllerName>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<operationStatus>NOT_ATTEMPTED</operationStatus>
<reason>String value</reason>
</operationResult>
</operationResults>
</guestUserOperationResultsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/guestUser.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/guestUser",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"guestUserOperationResultsDTO" : {
"operationType" : "CREATE",
"operationResults" : {
"operationResult" : {
"controllerName" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"operationStatus" : "NOT_ATTEMPTED",
"reason" : "String value"
}
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/guestUser
Unmodified
This resource has not been modified since the previous API version.
Request Payload 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
|
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 for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.
|
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.
|
locationGroupId
Long
|
ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
password
String
|
Password of the guest user.
|
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.
|
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
|
|
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
|
results
GuestUserOperationResultDTO[]
|
The result of the operation on a certain WLAN controller.
|
controllerName
String
|
The name of a controller.
|
ipAddress
InetAddress
|
The IP address of a controller.
|
operationStatus
GuestUserOperationStatus
|
The status of applying a guest account to a controller.
Allowed values:
- NOT_ATTEMPTED
- REJECTED
- FAILURE
- PARTIAL_FAILURE
- SUCCESS
|
reason
String
|
The info about a failure reason.
|
|
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 Request Payload
https://localhost/webacs/api/v2/op/guestUser
<?xml version="1.0" ?>
<manageGuestUsersDTO>
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<configGroup>String value</configGroup>
<controllerIds>
<controllerId>15</controllerId>
</controllerIds>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-12-21T12:09:31.738+07:00</endTime>
<locationGroupId>15</locationGroupId>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<userRole>String value</userRole>
<username>String value</username>
</manageGuestUsersDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/guestUser.json
{
"manageGuestUsersDTO" : {
"applyGuestUserTo" : "CONTROLLER_LIST",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15 ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : 1545368971738,
"locationGroupId" : 15,
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"userRole" : "String value",
"username" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/guestUser
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/guestUser" rootUrl="https://localhost/webacs/api/v2/op">
<guestUserOperationResultsDTO>
<operationType>CREATE</operationType>
<operationResults>
<operationResult>
<controllerName>String value</controllerName>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<operationStatus>NOT_ATTEMPTED</operationStatus>
<reason>String value</reason>
</operationResult>
</operationResults>
</guestUserOperationResultsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/guestUser.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/guestUser",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"guestUserOperationResultsDTO" : [ {
"operationResults" : {
"operationResult" : [ {
"controllerName" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"operationStatus" : "NOT_ATTEMPTED",
"reason" : "String value"
} ]
},
"operationType" : "CREATE"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/guestUser
Unmodified
This resource has not been modified since the previous API version.
Request Payload 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
|
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 for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.
|
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.
|
locationGroupId
Long
|
ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
password
String
|
Password of the guest user.
|
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.
|
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
|
|
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
|
results
GuestUserOperationResultDTO[]
|
The result of the operation on a certain WLAN controller.
|
controllerName
String
|
The name of a controller.
|
ipAddress
InetAddress
|
The IP address of a controller.
|
operationStatus
GuestUserOperationStatus
|
The status of applying a guest account to a controller.
Allowed values:
- NOT_ATTEMPTED
- REJECTED
- FAILURE
- PARTIAL_FAILURE
- SUCCESS
|
reason
String
|
The info about a failure reason.
|
|
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 Request Payload
https://localhost/webacs/api/v3/op/guestUser
<?xml version="1.0" ?>
<manageGuestUsersDTO>
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<configGroup>String value</configGroup>
<controllerIds>
<controllerId>15</controllerId>
<controllerId>25</controllerId>
</controllerIds>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-12-21T12:09:31.741+07:00</endTime>
<locationGroupId>15</locationGroupId>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<userRole>String value</userRole>
<username>String value</username>
</manageGuestUsersDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/guestUser.json
{
"manageGuestUsersDTO" : {
"applyGuestUserTo" : "CONTROLLER_LIST",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15, 25 ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-12-21T05:09:31.741Z",
"locationGroupId" : 15,
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"userRole" : "String value",
"username" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/guestUser
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/guestUser" rootUrl="https://localhost/webacs/api/v3/op">
<guestUserOperationResultsDTO>
<operationType>CREATE</operationType>
<operationResults>
<operationResult>
<controllerName>String value</controllerName>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<operationStatus>NOT_ATTEMPTED</operationStatus>
<reason>String value</reason>
</operationResult>
<operationResult>
<controllerName>Another string value</controllerName>
<ipAddress>
<address>192.168.115.244</address>
</ipAddress>
<operationStatus>REJECTED</operationStatus>
<reason>Another string value</reason>
</operationResult>
</operationResults>
</guestUserOperationResultsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/guestUser.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/guestUser",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"guestUserOperationResultsDTO" : [ {
"operationResults" : {
"operationResult" : [ {
"controllerName" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"operationStatus" : "NOT_ATTEMPTED",
"reason" : "String value"
}, {
"controllerName" : "Another string value",
"ipAddress" : {
"address" : "192.168.115.244"
},
"operationStatus" : "REJECTED",
"reason" : "Another string value"
} ]
},
"operationType" : "CREATE"
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/guestUser
Unmodified
This resource has not been modified since the previous API version.
Request Payload 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
|
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 for applying the guest account. This field using only if applyGuestUserTo equals CONTROLLER_LIST.
|
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.
|
locationGroupId
Long
|
ID of the location group. This field using only if applyGuestUserTo equals INDOOR_AREA or OUTDOOR_AREA.
|
password
String
|
Password of the guest user.
|
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.
|
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
|
|
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
|
results
GuestUserOperationResultDTO[]
|
The result of the operation on a certain WLAN controller.
|
controllerName
String
|
The name of a controller.
|
ipAddress
InetAddress
|
The IP address of a controller.
|
operationStatus
GuestUserOperationStatus
|
The status of applying a guest account to a controller.
Allowed values:
- NOT_ATTEMPTED
- REJECTED
- FAILURE
- PARTIAL_FAILURE
- SUCCESS
|
reason
String
|
The info about a failure reason.
|
|
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 Request Payload
https://localhost/webacs/api/v4/op/guestUser
<?xml version="1.0" ?>
<manageGuestUsersDTO>
<applyGuestUserTo>CONTROLLER_LIST</applyGuestUserTo>
<configGroup>String value</configGroup>
<controllerIds>
<controllerId>15</controllerId>
<controllerId>25</controllerId>
</controllerIds>
<description>String value</description>
<disclaimer>String value</disclaimer>
<endTime>2018-12-21T12:09:31.744+07:00</endTime>
<locationGroupId>15</locationGroupId>
<password>String value</password>
<profile>String value</profile>
<rebootController>true</rebootController>
<saveConfigToFlash>true</saveConfigToFlash>
<userRole>String value</userRole>
<username>String value</username>
</manageGuestUsersDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/guestUser.json
{
"manageGuestUsersDTO" : {
"applyGuestUserTo" : "CONTROLLER_LIST",
"configGroup" : "String value",
"controllerIds" : {
"controllerId" : [ 15, 25 ]
},
"description" : "String value",
"disclaimer" : "String value",
"endTime" : "2018-12-21T05:09:31.744Z",
"locationGroupId" : 15,
"password" : "String value",
"profile" : "String value",
"rebootController" : true,
"saveConfigToFlash" : true,
"userRole" : "String value",
"username" : "String value"
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/guestUser
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/guestUser" rootUrl="https://localhost/webacs/api/v4/op">
<guestUserOperationResultsDTO>
<operationType>CREATE</operationType>
<operationResults>
<operationResult>
<controllerName>String value</controllerName>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<operationStatus>NOT_ATTEMPTED</operationStatus>
<reason>String value</reason>
</operationResult>
<operationResult>
<controllerName>Another string value</controllerName>
<ipAddress>
<address>192.168.115.244</address>
</ipAddress>
<operationStatus>REJECTED</operationStatus>
<reason>Another string value</reason>
</operationResult>
</operationResults>
</guestUserOperationResultsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/guestUser.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/guestUser",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"guestUserOperationResultsDTO" : [ {
"operationResults" : {
"operationResult" : [ {
"controllerName" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"operationStatus" : "NOT_ATTEMPTED",
"reason" : "String value"
}, {
"controllerName" : "Another string value",
"ipAddress" : {
"address" : "192.168.115.244"
},
"operationStatus" : "REJECTED",
"reason" : "Another string value"
} ]
},
"operationType" : "CREATE"
} ]
}
}