Deletes a guest user.
Since Product Version: 3.2
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
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/op/guestUser/delete
Request Parameters
username
String
|
query
|
RequiredThe name of the guest user to delete
|
Request Payload Parameters
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
CREATE
UPDATE
DELETE
|
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/delete?username=name
<?xml version="1.0" ?>
<controllerIdListDTO>
<wlanControllerIds>
<wlanControllerId>15</wlanControllerId>
</wlanControllerIds>
</controllerIdListDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v1/op/guestUser/delete.json?username=name
{
"controllerIdListDTO" : {
"wlanControllerIds" : {
"wlanControllerId" : 15
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v1/op/guestUser/delete?username=name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/guestUser/delete?username=name" 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/delete.json?username=name
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/guestUser\/delete?username=name",
"@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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/op/guestUser/delete
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
username
String
|
query
|
RequiredThe name of the guest user to delete
|
Request Payload Parameters
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
CREATE
UPDATE
DELETE
|
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/delete?username=name
<?xml version="1.0" ?>
<controllerIdListDTO>
<wlanControllerIds>
<wlanControllerId>15</wlanControllerId>
</wlanControllerIds>
</controllerIdListDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v2/op/guestUser/delete.json?username=name
{
"controllerIdListDTO" : {
"wlanControllerIds" : {
"wlanControllerId" : [ 15 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v2/op/guestUser/delete?username=name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/guestUser/delete?username=name" 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/delete.json?username=name
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/guestUser/delete?username=name",
"@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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/op/guestUser/delete
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
username
String
|
query
|
RequiredThe name of the guest user to delete
|
Request Payload Parameters
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
CREATE
UPDATE
DELETE
|
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/delete?username=name
<?xml version="1.0" ?>
<controllerIdListDTO>
<wlanControllerIds>
<wlanControllerId>15</wlanControllerId>
<wlanControllerId>25</wlanControllerId>
</wlanControllerIds>
</controllerIdListDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/guestUser/delete.json?username=name
{
"controllerIdListDTO" : {
"wlanControllerIds" : {
"wlanControllerId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/guestUser/delete?username=name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/guestUser/delete?username=name" 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/delete.json?username=name
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/guestUser/delete?username=name",
"@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?
|
Yes
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Write
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/op/guestUser/delete
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
username
String
|
query
|
RequiredThe name of the guest user to delete
|
Request Payload Parameters
Response Parameters
operationType
GuestUserOperationType
|
The operation type.
Allowed values:
CREATE
UPDATE
DELETE
|
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/delete?username=name
<?xml version="1.0" ?>
<controllerIdListDTO>
<wlanControllerIds>
<wlanControllerId>15</wlanControllerId>
<wlanControllerId>25</wlanControllerId>
</wlanControllerIds>
</controllerIdListDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/guestUser/delete.json?username=name
{
"controllerIdListDTO" : {
"wlanControllerIds" : {
"wlanControllerId" : [ 15, 25 ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/guestUser/delete?username=name
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/guestUser/delete?username=name" 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/delete.json?username=name
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/guestUser/delete?username=name",
"@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"
} ]
}
}