Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET guestUser/loggedInGuestUsersOnController

Lists guest user names currently logged in and associated to a particular controller.

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 Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController

Unmodified

This resource has not been modified since the previous API version.

Request Parameters

Attribute Source Description

controllerId Long

query

Required

The Id of WLAN controller to return logged in guest users.

Response Parameters

Attribute Description

username String[]

The name of a guest user.

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 Response Payload

https://localhost/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController?controllerId=1

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController?controllerId=1" rootUrl="https://localhost/webacs/api/v4/op">
  <guestUserNamesDTO>
    <usernames>
      <username>String value</username>
      <username>Another string value</username>
    </usernames>
  </guestUserNamesDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController.json?controllerId=1

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v4/op/guestUser/loggedInGuestUsersOnController?controllerId=1",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v4/op",
    "guestUserNamesDTO" : [ {
      "usernames" : {
        "username" : [ "String value", "Another string value" ]
      }
    } ]
  }
}