Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

PUT guestUser/delete

Deletes a guest user.

Since Product Version: 3.2

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

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

Attribute Source Description

username String

query

Required

The name of the guest user to delete

Request Payload Parameters

Attribute Description

wlanControllerId Long[]

Id of WLAN controller.

Response Parameters

Attribute Description

operationType GuestUserOperationType

The operation type.

  • CREATE
  • UPDATE
  • DELETE
  • SCHEDULE

results Arrow image GuestUserOperationResultDTO[]

The result of the operation on a certain WLAN controller.

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://10.64.88.203/webacs/api/v1/op/guestUser/delete?username=name

<?xml version="1.0" ?>
<controllerIdListDTO>
  <wlanControllerIds>
    <wlanControllerId>15</wlanControllerId>
    <wlanControllerId>25</wlanControllerId>
  </wlanControllerIds>
</controllerIdListDTO>

Sample JSON Request Payload

https://10.64.88.203/webacs/api/v1/op/guestUser/delete.json?username=name

{
  "controllerIdListDTO" : {
    "wlanControllerIds" : {
      "wlanControllerId" : [15,
      25]
    }
  }
}

Sample XML Response Payload

https://10.64.88.203/webacs/api/v1/op/guestUser/delete?username=name

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.64.88.203/webacs/api/v1/op/guestUser/delete?username=name" rootUrl="https://10.64.88.203/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>
      <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://10.64.88.203/webacs/api/v1/op/guestUser/delete.json?username=name

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : //10.64.88.203/webacs/api/v1/op/guestUser/delete?username=name",
    "@rootUrl" : "https : //10.64.88.203/webacs/api/v1/op",
    "guestUserOperationResultsDTO" : {
      "operationType" : "CREATE",
      "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"
        }]
      }
    }
  }
}