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

POST guestUser

Creates a new 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

POST

Resource URL

/webacs/api/v3/op/guestUser

Unmodified

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

Request Payload Parameters

Attribute Description

applyGuestUserTo ApplyGuestUserTo

Required

Approach to choose a set of controllers for applying the guest user account.

  • 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

Required

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 WlanProfiles API for getting a list of profiles.

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

Required

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 WlanControllerDetails for getting a list of user roles appropriate for a controller.

username String

Required

Name of the guest user.

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://172.20.127.108/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>1986-07-24T00:00:00Z</endTime>
  <locationGroupId>15</locationGroupId>
  <profile>String value</profile>
  <userRole>String value</userRole>
  <username>String value</username>
  <password>String value</password>
  <rebootController>true</rebootController>
  <saveConfigToFlash>true</saveConfigToFlash>
</manageGuestUsersDTO>

Sample JSON Request Payload

https://172.20.127.108/webacs/api/v3/op/guestUser.json

{
  "manageGuestUsersDTO" : {
    "applyGuestUserTo" : "CONTROLLER_LIST",
    "configGroup" : "String value",
    "controllerIds" : {
      "controllerId" : [ 15, 25 ]
    },
    "description" : "String value",
    "disclaimer" : "String value",
    "endTime" : "1986-07-24T00:00:00.000Z",
    "locationGroupId" : 15,
    "password" : "String value",
    "profile" : "String value",
    "rebootController" : true,
    "saveConfigToFlash" : true,
    "userRole" : "String value",
    "username" : "String value"
  }
}

Sample XML Response Payload

https://172.20.127.108/webacs/api/v3/op/guestUser

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../pages/common/login.jsp.html" rootUrl="https://172.20.127.108/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://172.20.127.108/webacs/api/v3/op/guestUser.json

{
  "mgmtResponse" : {
    "@requestUrl" : "../../../pages/common/login.jsp.html",
    "@responseType" : "operation",
    "@rootUrl" : "https://172.20.127.108/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"
    } ]
  }
}